One stop destination for showcasing the community you have built.
Let's setup the backend server on your local machine.
- Install Node.js
Fork this repo to your GitHub account
Clone the forked repo to your local machine
git clone https://github.com/<YOUR-GITHUB-USERNAME>/causefolio.git
Navigate to project directory
cd causefolio
npm install
A firebase account is already created, but you will not have the access to it.
- To use your own firebase instance, create a new firebase project using firebase console.
- After creating a project, go to project settings.
- In project settings of your newly created project there will be a section called 'Your Apps' which says 'There are no apps in your project, Select a platform to get started.'
- Click on the 'WebApp' Icon, then it will ask to register a new App.
- In the 2nd step of app registration, firebase will provide to you the firebase credentials of your app.
- Now change it to provide your firebase credentials here
- You will have to set up remote repositories for getting latest changes from original repository
- Specify a new remote upstream repository that will be synced with the fork using following command :
$ git remote add upstream https://github.com/codeforcauseorg/causefolio.git
- Verify the new upstream repository you've specified for your fork using
git remote -v
origin https://github.com/<your-user-name>/causefolio.git (fetch)
origin https://github.com/<your-user-name>/causefolio.git (push)
upstream https://github.com/codeforcauseorg/causefolio.git (fetch)
upstream https://github.com/codeforcauseorg/causefolio.git (push)
Your application setup is successfully completed!
# development
$ npm run start
- After doing changes, Run the command
npm run build
to build the app for production to thebuild
folder.
# build for production
npm run build
- PRs should be generated against
development
. - Remember to run
npm run format
before creating pull request. - Netlify willl create a preview inside pull request, Please check if your work is fine.
.
├── build # Compiled files
├── src # Source files
└── ...
.
├── ...
├── src
│ ├── ...
│ ├── assets # assets for the website
| ├── index.js # starting point
│ └── ...
└── ...
Kunal Kushwaha Project Head |
Abhishek Kumar Maintainer |
Shitiz Aggarwal Designer, Frontend |
Rishabh Singh UI/UX Designer |
Abhinav Sinha UI/UX & Frontend |
Aditya Teltia Contributor |
Md. Pial Ahamed Contributor |
Rizwan Memon Contributor |