API to manage a Database implemented in games created by Lehigh RiVR Immersive Learning using Unity.

• TypeScript
• NodeJS
• ExpressJS
• Swagger
• MongoDB

• dev: Starts a server as a DEV environment localhost:3333
• build: Creates a project BUILD
• start: Starts a simple server with the PRODUCTION code

To clone and execute this application, you will need to have Git, NodeJs, Yarn installed in your computer.

# Clone this repository
$ git clone https://github.com/Alquipo/userCollectionDataUnity-api

# Access the project folder in terminal/cmd
$ cd userCollectionDataUnity-api

# Install the dependencies
$ npm install

# Execute the Application in DEVELOPMENT
$ npm run dev

# The server will start in port:3333 
- Access http://localhost:3333 

http://localhost:3333 (this link is clickable 😉)

#GENERATE the application build
$ npm run build

#ECECUTE the application build
$ npm run start

#added .env.example in the project. REMEMBER to add the environment variables according to the example below

# Example of a database location
MONGODB_URI=mongodb+srv://<Username>:<Password>@cluster0.sv24h.mongodb.net/<DatabaseName>?retryWrites=true&w=majority

• Make a fork of this project;
• Create a new branch with your modifications: git checkout -b my-feature
• Save the changes and type a short commit message describing what you have done: git commit -m "feature: My new feature"
• Send your modifications: git push origin my-feature

In case of doubt, check this tutorial out! Guide: how to contribute in GitHub

This project is under the MIT lincese. Visit LICENSE to learn more about it.

Translation made by Junior 🐼

Documentation template made with ❤️ by Alquipo Neto 👋🏽 Get in touch!