The documentation is built not only for the JS Developers, but also for both of full stack developers from other different fields and those with less technical backgrounds in a team.
The entire project is writtin in JavaScript using NodeJS stuff. There are two seperate projects: api-server(API Server) written in expressJS and ui(UI) written in ReactJS.
To run the project, first you need to step up the server side first. For more info, find out the README.md of api-server directory. After that, run the React app at ui project with npm. For more info, check in the README.md of ui directory.
For the plain code review, you can type . at the root directory of the projects(UI & Server). Then, you will automatically reach to the web-based VS Code editor.
For those who want to review the project on non-dev environment, there is a directory named presentation assets for non-dev project review.
- NodeJS environment
- MySQL Database
- VS Code & REST Client extension (For Smoother API Testing)
This is the UI Project Repository.
This is the API Server Project Repository.
This is the presentation assets Directory.