Welcome to TeamOneFootOutTheDoor's frontend GitHub for CandorVille. If you were looking for the main GitHub, go here.
In this README, you can find useful information on the things that you can do in terms of commands in the frontend. For all intents and purposes, we will assume that you are in the frontend directory when you are inputting these commands.
Make sure that you've successfully completed the Getting Started (Post-Inherit) section back from our main GitHub.
Taken from here.
It is recommended that you run the Lint tests locally so that you can make sure that your code will be passing for the CI in terms of Lint.
Run the following commands:
yarn run tslint
yarn run elint:summary
This will start TSLint and ESLint respectively on the frontend. You will have passed all the Lint tests if you are brought up to another command-line prompt and no errors were listed.
Taken from here.
It is recommended that you run the other tests locally so that you can make sure that your code will be passing for the CI in terms of the other tests.
Run the following commands:
yarn test
This will run the test suites that have been made for this project and let you know how how many of them are passing. If you want to find out how to make your own tests, check out Testing
Taken from here.
Like with the Linter, it is recommended that you run this part locally to make sure that it will cause no errors during the CI.
Run the following commands:
yarn run docs
If all goes well, it should produce a new folder called adocs in the frontend directory. Do not push adocs to GitHub. CI should handle that automatically if set up properly.
In this directory, run the following command to start a local version of the application so you can test out any features you're working on:
yarn start
It will take a while to load since it has to compile in the background, but once it's finished, it should take you to localhost:3000 or something like that and dispaly the application if it compiles without problems.
You can then make changes to your code and update them on the running local application by just refreshing the page. To end it, use Ctrl-c.
Generated using TypeDoc