Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 840 Bytes

readme.md

File metadata and controls

22 lines (16 loc) · 840 Bytes
Raw

Samfish Webserver 🐠

The RESTful backend API for Années-lumière.

Installation

Installing and running the backend application

  1. Fork it 🍴!
  2. cd to the project folder
  3. Install NPM and NVM in order to run NodeJS
  4. Run sudo npm install to install all the node modules for the application.
  5. Run sudo npm run dev to run the server on localhost, which will be running on 'http://localhost:5000' and enjoy your dev 🍺

Contributing

  1. Fork it 🍴
  2. Clone it 👬 git clone https://github.com/devname/Samfish-Webserver.git
  3. Create your feature branch: git checkout -b my-new-feature
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request 💪 💯