0xdeepak / causefolio

For the community, by the community.

CauseFolio

Description

One stop destination for showcasing the community you have built.

Table of Contents

• Tech Stack
• Setup and Run
  • Setup local repo
  • Setup Firebase credentials
  • Setup remote
  • Update fork repo
  • Run app
  • Build app
• Contributing and PR
• Project Structure
• Src Structure
• Contributors

⚙️ Tech Stack

• JavaScript/TypeScript
• NodeJs
• ReactJS

🔨 Setup and Run

Setup local repo

Let's setup the backend server on your local machine.

0. Prerequisites

• Install Node.js

1. Fork repo

Fork this repo to your GitHub account

2. Clone repo

Clone the forked repo to your local machine

git clone https://github.com/<YOUR-GITHUB-USERNAME>/causefolio.git

Navigate to project directory

cd causefolio

3. Install Dependencies

npm install

4. Setup firebase for development (optional)

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

5. 📡 Setup remote

0. You will have to set up remote repositories for getting latest changes from original repository
1. 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

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

6. Update Fork Repo From Original Repo (Optional)

0. Follow these steps if you are done with Setup Remote ✅.
1. Update your local Master to be in synch with the original repo.

$ git pull upstream <name_of_branch>

2. Update the forked repo master by pushing the local repo up.

$ git push origin <name_of_branch>

Running the app

# development
$ npm run start

Build Setup

• After doing changes, run the command npm run build to build the app for production to the build folder.

# build for production
npm run build

Contributions and PR

• PRs should be generated against development.
• Remember to run npm run format before creating pull request.
• Netlify will create a preview inside pull request. Please check if your work is fine.

Project Structure

.
├── build                   # Compiled files
├── src                     # Source files
└── ...

Src Structure

.
├── ...
├── src
│   ├── ...
│   ├── assets              # assets for the website
|   ├── index.js            # starting point
│   └── ...
└── ...

Thanks to all the contributors ❤️