eureka-web-app

KO | EN

gitlite — search

#javascript #react #typescript #llm #golang #go #android #linux #java #windows #awesome #kubernetes #awesome-list #security

(★ 9)

A responsive web app built on Vue 3 and Firebase that aims to connect members of the MUMTEC academic community with each other and opportunities within the community.

eureka-web-app 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<br />
<p align="center">
  <a href="https://github.com/MUM-Open-Source/eureka-web-app">
    <img src="src/assets/logo.png" alt="Logo" width="200">
  </a>

<h3 align="center">Eureka Web App</h3>

<p align="center">
    A responsive web app built on Vue 3 and Firebase that aims to connect members of the MUM academic community with each other and opportunities within the community.
    <br />
    <br />
    <a href="https://eureka-monash.com/">Visit Website</a>
    ·
    <a href="https://github.com/MUM-Open-Source/eureka-web-app/issues">Report Bug</a>
    ·
    <a href="https://github.com/MUM-Open-Source/eureka-web-app/issues">Request Feature</a>
  </p>
</p>

<details open="open">
  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
        <li><a href="#learning-resources">Learning Resources</a></li>
      </ul>
    </li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact--community">Contact & Community</a></li>
    <li><a href="#contributors">Contributors</a></li>
  </ol>
</details>

## About The Project

Our vision is to be the go-to platform for the academic community to discover collaborative opportunities by fostering a sense of communal growth. Eureka is still in its early stages and with your help, we can make it a great community-centric platform!

Some of our current core features include:

-   a page to browse through relevant tech events happening
-   a page to find other talent within the community to team up with
-   a page to find mentors who provide guidance to the talent
-   an admin dashboard

### Built With

-   [Vue 3](https://v3.vuejs.org/)
-   [Firebase](https://firebase.google.com/)
-   [Netlify](https://www.netlify.com/)
-   [TypeScript](https://www.typescriptlang.org/docs/)

## Getting Started

To get a local copy up and running, follow these simple steps.

### Prerequisites

Please make sure to have the following installed:

-   [Node.js](https://nodejs.org/en/download)
-   [VueCLI](https://cli.vuejs.org/guide/installation.html)

### Installation

Follow these steps to setup the project:

1. Fork this repository
2. Clone the forked repository using GitHub Desktop or the following git command:

```sh
git clone "enter-your-fork-url"
```

3. cd into the project file by running the following command:

```sh
cd eureka-web-app
```

4. Install the project dependencies by running the following command:

```sh
npm install
```

5. Add the environment file so that your project will be able to communicate with our servers. To do this, add a file to the root folder and name it '.env'. The content of the file should be as follows:

```sh
VUE_APP_FIREBASE_API_KEY=AIzaSyBtNOw1Jf-4gOtmoHvz9qjmEp_DvVzerLA
VUE_APP_FIREBASE_PROJECT_ID=eureka-development-860d4
VUE_APP_FIREBASE_MESSAGING_SENDER_ID=352539377412
VUE_APP_FIREBASE_APP_ID=1:352539377412:web:a9c49cb6afce7aa082da51
```

6. To run the app through localhost:

```sh
npm run serve
```

### Learning Resources

Our project welcomes student developers with any level of experience to contribute to the platform. Our goal is to help you on your journey as a developer and also provide extensive support to first-time open source contributors.

Here are some useful resources that will help you in contributing to this project:

#### Git & GitHub

-   [What is Git, GitHub & version control?](https://youtu.be/r50BKIFGCI0)
-   [Creating forks and pull requests](https://youtu.be/nT8KGYVurIU)
-   [Git and GitHub playlist for beginners](https://youtube.com/playlist?list=PLB5jA40tNf3v1wdyYfxQXgdjPgQvP7Xzg)
-   [Commit message conventions suggested for Eureka](https://github.com/vuejs/vue-next/blob/master/.github/commit-convention.md)

#### Frontend Development

-   [Vue 3 crash course](https://youtu.be/ZqgiuPt5QZo)
-   [Vue 3 documentation](https://v3.vuejs.org/guide/introduction.html#what-is-vue-js)

#### Eureka Project-Related (IMPORTANT FOR CONTRIBUTORS)

-   [Project setup video tutorial](https://youtu.be/XNotTHShgS8)
-   [Code structure walthrough video](https://youtu.be/ja5hhgeDNiw)

## Contributing

Contributions are what make the open source community such an amazing place to be. Let's learn, inspire, and create together. Any contributions you make are **greatly valued** and impact all our users from Monash University Malaysia.

You can see the [open issues](https://github.com/MUM-Open-Source/eureka-web-app/issues) for a list of proposed features (and known issues). Feel free to go ahead and propose/request a feature or report a bug by [submitting a new issue](https://github.com/MUM-Open-Source/eureka-web-app/issues/new).

1. After identifying the [issue](<(https://github.com/MUM-Open-Source/eureka-web-app/issues)>) you would like to work on, comment on the it and wait for our team to assign the issue to you.
2. Ensure that you have followed the [installation](#installation) steps mentioned above and gone through the [project-related resources](#eureka-project-related-important-for-contributors).
3. Create your feature branch (`git checkout -b feature/your-amazing-feature`).
4. Commit your changes (`git commit -am 'adding my amazing feature'`).
5. Push to the branch (`git push origin feature/your-amazing-feature`).
6. Open a Pull Request on GitHub from your fork to our repo.

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact & Community

Join our [Discord](https://discord.gg/hUfnkcGKf4) community to be involved with our discussions and progress.

You can alternately [email](mailto:eurekaqh88@gmail.com) our team.

Our social media:

-   [LinkedIn](https://www.linkedin.com/company/eureka-open-source/)
-   [Instagram](https://www.instagram.com/eureka_open_source/)

## Contributors

Thanks to our awesome contributors who are passionate about open source! When you contribute, your image account also gets displayed here :)

eureka-web-app

eureka-web-app 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

eureka-web-app

eureka-web-app 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README