SHPE-UTDallas / ResumeBook

A serverless web application to help recruiters get in contact with SHPE UT Dallas members.

ResumeBook

Stable/Master Branch Build: https://shpe-utdallas.github.io/ResumeBook/

Dev Build: https://resumebook.netlify.app/

A serverless web application to help recruiters get in contact with SHPE UT Dallas members. Built with: React, React Router, and Redux for the Front End and Node.js +Express with Firebase's Cloud Firestore as a database for the Backend. Hosted on Netlify

Getting ResumeBook Setup for Local Development

1. Ensure you are a member of the SHPE-UTDallas GitHub organization. (Or Fork the project and follow the rest of the steps. I will not be covering this in-depth and will assume you know what you're doing)
2. Clone the repository: git clone https://github.com/SHPE-UTDallas/ResumeBook.git
3. Make sure you have version 12 of node.js installed node -v
   • You shoud see v12.x.x printed out, if not install the latest version of node.js 12 here: https://nodejs.org/en/
4. Install the Netlify CLI npm install netlify-cli -g
   • More info avaliable here: https://docs.netlify.com/cli/get-started/#installation
5. Install Yarn (our package manager) npm install yarn -g
6. Install dependencies for the front end (React) cd ResumeBook && yarn
7. Install dependencies for the back end (Node.js) cd src/functions && yarn
8. Create a netlify account on https://www.netlify.com/
   1. Go to the main page and click "New site from Git" in the top right-hand corner
   2. Under the "Continuous Deployment" heading choose GitHub
   3. You should see your GitHub username and an arrow next to it. Click on it and select SHPE-UTDallas from the dropdown
   4. Select the "ResumeBook" repository from the list
   5. Select which branch you want the the build to deploy from (I would choose dev for now but once you have started contributing I would have it build and deploy from the branch you are working in)
   6. Click deploy site (Don't worry about the build command and publish directory - that's taken care of by our netlify.toml config file)
   7. Go to the dashboard for your site. You should see should see Overview, Deploys, Plugins, Functions, etc. tabs at the top of the page. Click on Deploys
   8. Click on "Deploy settings"
   9. Click on "Environment", located on the left-hand side underneath the "Build & Deploy" heading
   10. Click on "Edit variables", located underneath the "Environment variables" heading
   11. Input the environment variables I provided you to setup your test environment and then hit Save
9. Go to the root directory of the ResumeBook repository on your computer.
   1. If you've been following along exactly with this tutorial then entering cd ../.. should put you in the root directory
10. Create a file called .env in the root directory
    1. Inside that file input NODE_ENV=development
11. Run the command netlify login and login to your netlify account
12. Run the command netlify link and select Use current git remote origin
    1. This step will allow you to link your project to your netlify account and makes sure the environment variables you just set are injected into your environment
13. Run the command netlify dev in your terminal
14. The ResumeBook web application should now be running on your local machine!