Newslang

Chalkboard view

Sentence and Card view

Installation

# cd ./frontend  & cd ./backend
npm install

Usage

# cd ./frontend
npm start

# cd ./backend
nodemon server.js

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Branch Naming Convention

example: FIX-GHUB-1-add_2_tests

1. Branch reason (uppercase)

   • Bug Fix - FIX
   • Feature - FET
   • Experimental Branches - EXP

2. Issue location - issue identifier (uppercase)

   • ex: "GHUB-1" (GitHub issue #1)

3. Branch name (lowercase)

   • use underscors to seperate words in name
   • verb-objec-location structure
   • max 6 words in name

License

MIT