Code Monkey home page Code Monkey logo

playercare's Introduction

Gaming Industry Help Desk

A client-server REST application designed for a tech support team at a video-game developing company, with the purpose of providing players of their cross-platform game, who experience game-related technical issues, a UI which assists them in opening support tickets and track their progress.

Project built with the MERN stack. For the frontend documentation see PlayerCare UI

Live Demo

View the Heroku deployed app here: PlayerCare


Run Scripts

Both the server (auto-reloads with nodemon) and the client applications are setup to run simultaneously in development mode using concurrently.

From your root project folder in your terminal run the following

npm run dev

and open http://localhost:3000 in your brower to view the app.

Server

The backend API is a Node/Express server which connects to a noSQL database in MongoDB using the Mongoose object modeling library.

To start the server by itself, also from the project folder run

# manually
npm start

# or auto-reloading with nodemon
npm run server

Client

The frontend UI is a React/Redux single-page application bootstrapped with Create React App using the Redux Toolkit template, e.g.

npx create-react-app frontend --template redux

To start the client by itself, also from your project folder run

npm run client

Dependencies

For installing npm packages

# backend/package.json
npm i <pkg>

# frontend/package.json
cd frontend
npm i <pkg>

Environment Variables

You'll need an .env file (on your root project folder) to include the MongoDB database connection URI and a JSON Web Token secret to encrypt user login info, i.e.

NODE_ENV=development
PORT=5000
MONGO_URI=mongodb+srv://<your-db-uri>
JWT_SECRET=soM3VeRyLOngAlPhaNUMer1cEncRypT10n

Here is a quick intro to MongoDB Atlas to setup your database.

playercare's People

Contributors

iancover avatar

Stargazers

Roman avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.