GTKEO is a networking application that allows software engineers to reciprocate connections, follows, and endorsements
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.
- Node
- NPM
- Clone repo
- Navigate to the root directory in your terminal and type 'npm install'
- Once that's finished, type 'npm run build'
- Include the .env file:
Expects a .env file in root directory with a PORT variable set to your choice of port. If you're unsure what that means:
- Save a new blank file that is specifically named '.env' (without the quotes), and save it at the very top level of this project, the same place where this very README exists (that's the root directory)
- Inside that file, type 'PORT=8000' (without the quotes!)
- Save the file
- That's it!
- Navigate to root directory in your terminal
- Make sure you have an active build (you'll see a /build folder in your directory). If it's your first time and you just cloned the repo, you won't have that. Not to worry! Just type 'npm run build' into your terminal
- Once you have the active build, type 'npm start'
- Alternatively, you can type 'npm devstart' to run with nodemon for easier changes
- Navigate to root directory in your terminal and type 'npm run test'
- Contributor Covenant - Used for the Code of Conduct
- Creative Commons - Used to choose the license
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Provided README Template - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details
- Hat tip to anyone whose code is used
- Inspiration
- etc