DSGT-Bootcamp / DSGTBootcampWebpage

React App for Data Science Club at Georgia Tech Bootcamp Website to help publish content/material
https://dsgtbootcamp.netlify.app
1 stars 0 forks source link
bootcamp cicd circleci data-science html-css-javascript netlify-deployment reactjs

DSGT Bootcamp Webpage

This project was bootstrapped with Create React App.

GitHub repo

Redesigned in February 2022 by Faris Durrani. :)

Documentation can be found in DSGTBootcampWebpage_Docs.md or DSGTBootcampWebpage_Docs.pdf files

Setup

  1. Install Node using nvm (Node Version Manager) using this guide. Aim to get Node v20 and NPM v10

  2. Verify that node and npm are installed by running node -v and npm -v to see that the Node version is v20 and npm version is v10

  3. Install yarn by running npm install -g yarn in the project directory

How to Run

In the project directory, run these commands:

yarn install
yarn run build
yarn start

"yarn install" (install node package manager)
"yarn run build" (this command essentially compiles the React.js web app)
"yarn start" (this will start up localhost:3000)

CI/CD

The CI/CD pipeline is powered by CircleCI and Netlify. CircleCI helps with running automated build checks to ensure that the frontend unit tests pass + the app builds fine. Netlify handles automated deployment of the DSGTBootcampWebpage (which triggers on webhook Circle CI passes to Netlify).

Some resources that might be helpful include the following:

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.