A GNOME Challenge 2020 project that aims to bring, engage, and retain new contributors to the open source community.
FOSSDorm is a free and open source platform to help newcomers find open source projects based on their skill preference, then learn how to contribute to the selected project, and engage them for the long term.
To achieve the same target, FOSSDorm aims to fulfills three basic needs:
- Where to find skill-based suitable project: GitHub is a large ocean where new contributors find hard to search for project meeting their demands. Hence, FOSSDorm provides a list of all verified and approved (by us) open source projects.
- How to contribute: Even after finding a project, contributors sometimes fail to engage with the community due to lack of good documentation for beginners. Hence, each project on FOSSDorm contains a separate page providing all informations about the project, how to set up a project at localhost, guide for contribution, and how to stay in touch with the community.
- How to engage contributors forever: FOSSDorm also has reward system that helps contributors build their profile displaying the amount of open source contribution they've done to the projects listed at FOSSDorm.
We at FOSSDorm highly promotes the open source softwares and hence use them as well against the proprietary or closed softwares.
Special mention to Fosshost, who provides free hosting to FOSS projects including FOSSDorm.
Before setting up project locally, you must have the following tools installed on your system:
- Git
- Mongodb database
- NPM
1. Fork the backend repository
2. Clone your own copy of repo
git clone https://github.com/<username>/backend.git
Here replace <username> with your own github username
3. Install dependencies
cd backend
npm install
4. Set Up localhost database
Once you install MongoDB on your system, run it and copy the URI address.
5. Add environment variables
Create .env file at the root of your project with the following entries and its values:
MONGODB_URI=<your_monogodb_uri_copied_in_last_step>
WEBSITE_URL="https://www.fossdorm.org"
5. Run API server at localhost
npm run dev
If you're able to see website running at localhost, then you're ready to make change and contribute.
1. Create your own branch and checkout
Though you can also make changes in your main branch and create pull request, we highly recommend you to make your own new branch and checkout to it before making any changes.
git branch <new-branch-name>
git checkout <new-branch-name>
Here replace <new-branch-name> with a new branch name you want to give. e.g. git branch my-changes
Now, make sure you're on the new branch.
git branch
2. Make changes
Once you switch to a new branch, make changes you want.
3. Commit new changes Once you're done testing your new changes at localhost, save the work by running commands:
git add .
git commit -m "<message>"
Here replace <message> with a small description of your new changes. e.g. "add project api", "fix connection".
4. Push local changes to remote
git remote --set-upstream origin <new-branch-name>
If you're prompted to enter GitHub username and password, enter your credential and you're ready to create a pull request.
Next time, you can only run git push origin to push new changes to remote.
5. Create pull request
Once you push all changes to your remote GitHub server, go to your own GitHub account >> backend repo and you'll see a notification of new changes.
Click on the "Compare & pull request" and then open a pull request from the next page.
To sync your local or remote repo with parent repo (from where you've forked), run commands:
git remote add upstream https://github.com/FOSSDorm/backend.git
git pull upstream main
Note: At localhost, you may find redirecting to production site in the login system. This happens as the GitHub OAuth callback is set to production site. To make it work on localhost, I need to change the callback url. Hence, currently, you may work on other components of website until I find its solution.
If you've any doubt or want to ask any question, feel free to message us through mail, slack, or telegram.