TPO-Frontend-App

This is the react repository that we will use to maintain the web frontend of the TPO project.

---

Prerequisites

Make sure you have installed

1. git
2. nodejs (and npm is working)

---

Getting started

1. Fork this repo https://github.com/aissmstpo/TPO-Frontend-App to your github account.
2. Clone that repository using

git clone https://github.com/yourid/path-to-repo.git

3. Initilize your local git instance using

git init

4. Assign the original repo to a remote called "upstream"

git remote add upstream https://github.com/aissmstpo/TPO-Frontend-App.git

5. If you cloned a while ago, get the latest changes from upstream:

git checkout master
git pull upstream master

6. Add remote origine

git remote add origin  https://github.com/yourid/path-to-repo.git

7. To setup the environment open cmd/terminal and run:

npm install

You are ready to work now. Complete your work then

8. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

git checkout -b <topic-branch-name>

9. Commit your changes

git commit -m "<write some message>"

10. Push your topic branch up to your fork:

git push origin <topic-branch-name>

11. Open a Pull Request with a clear title and description.

12. After your Pull Request is away, you might want to get yourself back onto master and delete the topic branch:

git checkout master
git branch -D <topic-branch-name>

---

Tools/dependencies we will be using

• Babel to convert ECMAScript 2015+ code into a backwards compatible version of JavaScript in old browsers or environments.
• Prettier It removes all original styling* and ensures that all outputted code conforms to a consistent style.
• Jsdoc this will help in Documentation.
• Also install the Prettier extension on you IDE.

---

Commands

• npm start compile the code, start server and show result in browser.
• npm build compile the code and save it to "dist" folder.
• npm run doc generates the documentation in "docs" folder, you can see the docs after you run npm strat on http://localhost:8080/docs/index.html