Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.72 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.72 KB
Raw

Dubium-Frontend

React project for Dubium Website.

Contribution Guidelines

  1. Fork this repo
  2. Clone your forked repo git clone
  3. Add the main repo as upstream git remote add upstream {url}
  4. Make your changes and push to your(forked) repo.
  5. Create a pull request from github to main repo.

To get some changes from main repo git pull upstream

NOBODY SHOULD DIRECTLY PUSH TO THE MAIN REPO.

There will be 2 branches

  • main
  • dev

Apart from the 2 branches above you can create as many branches as you want.

NOBOBY SHOULD MAKE PULL REQUEST TO MAIN BRANCH. All changes should be made to dev.

Folder structure

src
 |- api: To manage all api requests
 |- assets: As the name suggests, all the static assets should reside here
 |- components: Shared components used across features are placed here
 |- config: All the app’s configurations are to be kept at this path eg. date format, default language, some master data set
 |- store: It holds all the redux resources at one place
   |- reducer: Reduces all the actions and applies corresponding changes to store
   |- action: Each action file includes feature based action-creators
 |- pages: Consists of different pages in your app
 |- styles: This module holds our application-level styles
 |- utils: All the utility/helper methods, validations, etc. that can be shared across our entire project are added here

Apart from this you can create any folders if you want.

Important Notes

  • Commits and pull requests should be made with proper descriptive messages.
  • Do NOT commit or push any sensitive info such as passwords or emails in the code. Such data should go in the .env file, and a sample empty entry for the same should be added for the same in .env.example