Campfire (MERN APP)

Client Side

Prerequisites

• NodeJS
• Global node modules
  • react-devtools
  • eslint
• recommended (optional)
  • nvm (to install multiple node versions)

VSCode Plugins

• flowtype.flow-for-vscode
• dbaeumer.vscode-eslint
• gcazaciuc.vscode-flow-ide
• stevencl.adddoccomments
• donjayamanne.githistory
• ericamodio.gitlens
• prettier.prettier-codeformatter
• gruntfuggly.todo-tree

Run the app locally

1. cd client
2. Run command yarn install to install modules
3. Run command yarn start to run the app in the development mode.
4. Open http://localhost:3000 to view it in the browser.

Run the storybook

5. Run command yarn storybook to run the storybook.

Run Campfire API docs

1. Navigate to todo-list directory cd client
2. Install the dependencies yarn install. Make sure yarn is already installed, if not you can refer here https://classic.yarnpkg.com/en/docs/install/#mac-stable
3. It is recommended to install docsify-cli globally, which helps initializing and previewing the website locally. Run npm i docsify-cli -g to install it globally.
4. Run the local server with the command yarn docs.

Something To Learn

• Atomic Web Design
• Ant Design
• Storybook
• JSX - Typescript
• React Router
• Application State Management with React
• React Hooks
• React Context Api

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Server Side

Run the development server

1. Navigate to server directory. Run command 1. cd server
2. Run yarn install to install the needed dependencies. Make sure yarn is already installed in your machine if not you may refer here.
3. After installing modules run command yarn start.
4. Open http://localhost:5000 to view it in the browser. Then you may use rest client to test all available routes.