Asay
Chat with us on Slack
Stack
- Version control: GitHub
- Database: PostgreSQL
- Back-end: Node.js, Express.js
- Front-end: React
- Deployment: Zeit Now
Install local dev environment
Please follow the guide in the order it is presented to you.
Version control
- Sign up @ github
- Get an admin to add you as collaborator to the project
- Clone project from asayio/asay
- Get .env file from admin
Development
- Install node 8 from nodejs.org
- Install project libraries from terminal/command prompt
cd ./
npm install
- Run ./app and ./server
cd ./
npm start
Deployment
This step is only necessary if you need to publicly deploy the solution.
- Signup @ zeit.co
- Shut down your local instance if running (control+c)
- Build and deploy solution
cd [your local ./server
npm login
npm run build
now --public
- Go to the URL where the solution is deployed
Coding practice
Coding guidelines
- Indenting by tab
- Code, comments and naming must be in English
- All naming must be understandable and easily differentiable
- Don't do short names that has be explained!
- Use plural tense for multiple items
- Front-end naming by
PascalCase - Band-end naming by
camelCase
File-structure
- Files must be locateded as per
./src/domain/componentmapped logically (not perfectly correct) - Use subfolders when purposeful for reuse or overview
- Duplicate code must be refactored into reusable classes, functions etc.
Commits
- We use only one branch:
master - We flag a version as an release when a feature milestone has been tested.
- We do ongoing commits
- Ideally every commit should only contain a single new feature/change
- We start everyday off with pull to sync our code
Test
- Tests scripts are written and comitted along with the code
- Regressional unit tests are run (and succeeded) before commit
- Integration testing are done before a release