We also have a public chat room on Slack. Drop by and say hello in case you wish to contribute!
Nebula(project) is divided into two repositories. This repository contains the frontend codebase of the project. Checkout the backend codebase over here. This project aims to provide universities and communities with a platform which can be utilised to make the working of various clubs systematic.
The below installation guide is mainly based for windows user but should work for linux based users as well.
These are the requirement that should be installed locally on your machine.
- Node.js
- MongoDB (for running the backend codebase)
- Move to: link choose the operating system as per your machine and start downloading and setup by clicking recommended settings in the installation wizard.
- Move to: link look at the left sidebar and choose the operating system according to your machine. Then follow the steps recommended in the official docs.
- Move to: https://github.com/Bot-Academia/Nebula-Frontend
- Fork the repo
- Clone the repo using:
git clone https://github.com/Bot-Academia/Nebula-Frontend.git- Now move to the project directory on your machine.
cd nebula-Frontend
- Install all the dependencies using:
# install dependencies
$ npm install- Run the development server using:
# serve with hot reload at localhost:3000
$ npm run dev- Now the server is running on PORT 3000
Most of the prototyping is done using Figma. link to Figma project.
Also if you work/Create any ui part then it would be recommended to use ( #17a2b8 ) Css Color Code .
We are happy to see you here and we welcome your contributions towards Nebula. Contributions are not limited to coding only, you can help in many other ways which includes leaving constructive feedback to people's Pull Request threads also.
Nebula also provides an extensive list of issues, some of them includes labels like good-first-issue, help-wanted. You can take a look at good-first-issue issues if you are new here but you are free to choose any issue you would like to work on.
If there's no issue available currently, you can setup the project locally and find out the bugs/new features and open issues for that and discuss the bugs or features with the project maintainers or admins.
After choosing an issue and doing changes in the code regarding that, you can open up a Pull Request (PR) to main branch to get your work reviewed and merged!
Thanks goes to these wonderful people (emoji key):
 Vinayak Sharma 💻 |
 Hrishikesh Agarwal 💻 |
 Vivekkumar Javiya 💻 |
 Anurag Singh 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!