Eureka Web App

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.

Visit Website · Report Bug · Request Feature

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
• Firebase
• Netlify
• TypeScript

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
• VueCLI

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:

git clone "enter-your-fork-url"

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

cd eureka-web-app

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

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:

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:

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?
• Creating forks and pull requests
• Git and GitHub playlist for beginners
• Commit message conventions suggested for Eureka

Frontend Development

• Vue 3 crash course
• Vue 3 documentation

Eureka Project-Related (IMPORTANT FOR CONTRIBUTORS)

• Project setup video tutorial
• Code structure walthrough video

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 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.

1. After identifying the issue 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 steps mentioned above and gone through the project-related resources.
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 community to be involved with our discussions and progress.

You can alternately email our team.

Our social media:

• LinkedIn
• Instagram

Contributors

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