Purpose: The app is a customized form that collects weekly project data from internal staff at Teaching Lab.
To get started developing the application, there are a few commands the developer needs to run before running the app and editing the files.
git clone <github repo URL link>
In the terminal, when at the right directory that he wants to be in, the developer should use the command above to pull the code to the local environment. The github repo URL link in this case is https://github.com/TeachingLabHQ/monday-api-app.git The developer should be able to see and access the link by clicking the green Code tab.
cd <filename>
After cloning the project, the developer should see two files: api and frontend. He should use the above command to navigate himself to both files one at a time.
npm install
After navigating to the correct file path, the developer should use npm install to install all the modules and their dependencies the application needs in order to start running. Remember that the command should be run for both files.
vice should go. For security purposes, the key values are not displayed here. Please contact the owner and the developers for private keys.
npm start
After going through the instructions above, the final step to run the app is to again navigate to both files at api and frontend to start the backend and frontend of the app. And then, the developer should be able to see the application running at the localhost website.