SETUP.md

SETUP

To setup a local development environment, follow the steps given below.

1. Ensure you have NodeJS, npm, yarn and redis installed in your system.
2. Fork and then clone the repository

$ git clone https://github.com/<your-username>/COCWebsite.git

3. Install dependencies in both folders.

$ yarn

4. Generate environment variables in server and fill in the values.

$ cp server/.env.example .env

Your .env is ignored by git, which you can see in .gitignore, and so, it's safe!

5. Start the development servers

$ yarn dev

At the end of this, you should have

• server running at http://localhost:8000
• new_client running at http://localhost:3000
• redis running at PORT 6379

Adding/ Removing packages

The project is a monorepo, and dependencies are managed using Yarn Workspaces. To add a new package, follow the steps below.

• For adding/ removing a dependency in server

$ yarn workspace coc-server add/remove <package-name>

• For adding a dependency in new_client

$ yarn workspace coc-client add/remove <package-name>

Folder structure

Our folder structure

.
├── package.json # Maintains the dependencies using Yarn Workspaces
├── yarn.lock # Lock file
├── new_client
│   ├── public # Stores public files like index.html
│   └── src
│       ├── actions # Redux actions and types
│       ├── reducers # Redux reducers
│       ├── store # Redux store
│       └── components
│           └── auth # A component directory
└── server
    ├── src
    │   ├── config
    │   │   ├── dbconnect.js # Database connections.
    │   │   ├── index.js # Config object
    │   │   └── redis.js # Redis connection
    │   ├── controllers
    │   │   └── AuthController.js # Sample controller
    │   ├── middleware
    │   │   └── auth.js # Express middleware
    │   ├── models
    │   │   └── User.js # Mongoose model
    │   ├── utility # Standard utilities
    │   ├── views # .ejs files for mails
    │   ├── app.js # Main server file
    │   └── routes.js # Express routes
    └── test
        ├── api
        │   └── users_test.js # Sample test file using mocha, chai
        └── test_helper.js # Test config initializers

Bug/ Feature Request

Now that the development environment is all set up, head over to Contributing to learn how to contribute to COCWebsite.