lacouture100 / horizonte-api Goto Github PK

This is the repository for the Horizonte Clock server and website. You can find more instructions below if you wish to check it out.

• An internet browser.
• An internet connection.
• Access to computer terminal.
• Npm installed.
• Node.js installed.

1. Download the repository to your computer.
2. Open your terminal in the repository folder.
3. Make sure you have npm and node.js installed. You can check this with the following commands: npm - v node -v
4. If npm and/or node.js are not installed, you may follow this easy to follow guide from Tania Rascia. How to Install and Use Node.js and npm (Mac, Windows, Linux)
5. Once everything is installed, type in the following command while in the repository folder: npm start
6. Open your preffered browser and in the address bar type in http://localhost:3000/

To develop this document, you can follow the steps provided below:

1. Create a fork of this project on Github.
2. Ping the author of this repo via Github Issues to see if they are looking for contributions with the specific feature you're looking to add.
3. Open the file in VS Code and make updates .
4. Add and commit those changes in your forked Github repo.
5. Make a pull request specifying what additions and changes were made.
6. Have a nice chat and open communication with me about those changes.
7. Celebrate the contribution!

• VS Code
• Github
• Node.js
• npm

• Alvaro Lacouture

• The Good Project Readme Project