Welcome to the Y STEM and Chess project! This document will guide you through setting up your development environment.
This project uses NodeJS version 14
For Linux: sudo apt install nodejs
For Windows: https://www.geeksforgeeks.org/installation-of-node-js-on-windows/
Nodemon is a utility that will monitor for any changes in your source and automatically restart your server.
For Linux: sudo npm install -g nodemon
For Windows:npm install -g nodemon
Apache is a widely used web server software
For Linux: sudo apt update && sudo apt install apache2
For Windows: https://httpd.apache.org/docs/2.4/platform/windows.html
You should have been given access to a script named create_dev_envs.sh
- Paste this file into the root of the react repository
- Run it in the terminal by running
sh create_dev_envs.sh
- If you are on Windows, you will have to run the script in Git Bash
This project consists of several services. Here's how to set each one up:
- Navigate to the
react-ystemandchess
directory inside thereact
folder. - Run
npm install
to install the necessary dependencies. - run
npm start
to start the React development environment.
- Navigate to the
middlewareNode
directory inside thereact
folder. - Run
npm install
to install the necessary dependencies. - Run
nodemon index.js
to start the server.
- Navigate to the
stockfishServer
directory inside thereact
folder. - Run
npm install
andnpm i dotenv
to install the necessary dependencies. - Run
nodemon index.js
to start the server.
- Navigate to the
chessServer
directory inside thereact
folder. - Run
npm install
andnpm i dotenv
to install the necessary dependencies. - Run
nodemon index.js
to start the server.
The purpose of the chess Client is to
- Navigate to the
chessClient
directory inside thereact
folder. - Run
npm i dotenv
to install the necessary dependencies. - Install live server visual studio extension.
- To see the chessBoard only, click on index.html and select "run with live server".
- To see the chessBoard with parentWindow, right click on parent.html and select "run with live server"
- To see how both mentor and student interact, right click on both.html and select "run with live server"
The purpose of the chessClient React Refactor folder is to hold the chess game react component that will be imported into react-ystemandchess that interfaces with the ChessClient. To start this individually, do the following :
- Navigate to the 'chess-client-react-refactor'
- Run 'npm i dotenv' to install necessary dependencies.
- Start the react app by running 'npm start'
That's it! You've set up your development environment for the Y STEM and Chess project. Happy coding!