TaiGer Portal is running on Node.js. Make sure you already have Node environment and do not forget the package manager npm.
In order to run TaiGer Portal on the localhost, one terminal should run backend server (make sure MongoDB is available as it will connect MongoDB and open the port) while another run frontend server.
- Nodejs v18
- MongoDB v5.9
cd api
npm install
Enviornment setup
- copy
.env.sampleto.env.production,.env.development,.env.testand fill in the values
Install Mongo DB Before running backend server, make sure you have install MongoDB as database in your machine.
MacOS: Youtube-Install a local MongoDB Database on macOS
brew tap mongodb/brew
brew install mongodb-community@4.4 # version 4.4
brew services start mongodb-community@4.4 # start the mongodb as a service
Create Key and Pem file
MacOs: Youtube - Create Your Own SSL Certificate
The following code will generate the key and
cd api/cert
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout cert.key -out cert.pem -config req.cnf -sha256
After this step, you should have
- cert.key
- cert.pem
within the cert folder. Do not worry, in the .gitignore it will not commit your certifications into github :)
cd api
npm run-script dev
or the following for Production code:
cd api
npm run-script start
Run the following commands to get the all response type documentation of each API:
cd api/doc
npm start
- the
UPLOAD_PATHin.env.testwill be deleted whenever the test is run, be careful not to share the value with other.envfiles
- fill missing fields in
api/.env.sample
- Change your client/package.json
Instead of set, change to export How to specify a port to run a react-app
"scripts": {
"start": "export PORT=3006 && react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
If you open backend first time at Chrome, you need to go to https://localhost:3000/ and set it as safe manually.