📌 Simple streamer spotlight app with REST API server, based on the MERN stack. Project contains Express.js app as a backend (server) and React app as a frontend (client).
- Adding favorite streamers along with some relevant details
- Voting or unvoting existing streamers
- Searching through all existing streamers and displaying details about them
📚 Documentation of all available endpoints can be found here: API Documentation
- Clone repository
git clone https://github.com/jakubcieslik99/streamer-spotlight.gitℹ️ Instructions for running server app locally:
- Navigate to the server directory and install dependencies
cd streamer-spotlight/server
npm install- Run server app in development mode
npm run docker
npm run devℹ️ Instructions for running client app locally:
- Navigate to the client directory and install dependencies
cd streamer-spotlight/client
npm install- Run client app in development mode
npm run devℹ️ Instructions for building and running server app in production
- Transpile to production build
npm run build- Run server app in production mode
npm install --omit=dev
npm run startℹ️ Instructions for building client app to production
- Create production build
npm run build⚙️ To run server app, you will need to add the following environment variables to your .env file
-
DIR -
ENV -
MONGO_VER -
HOST -
PORT -
API_URL -
WEBAPP_URL -
MONGO_HOST -
MONGO_PORT -
MONGO_DB -
MONGO_USER -
MONGO_PASSWORD
( ℹ️ - sample .env config file is provided in the server directory under the name .env.sample )
⚙️ To build client app, you will need to add the following environment variables to your .env file
-
VITE_APP_ENV -
VITE_APP_API_URL
( ℹ️ - sample .env config file is provided in the client app directory under the name .env.sample )
🔤 Available client app languages: EN
If you have any feedback, please reach out to me at ✉️ contact@jakubcieslik.com