Description
Authors
Usage
Tech and Modules used
Route explanation
API Routes
Rest-API for WebApp.This WebApp is an online IDLE Game, based in Liège. The purpose is to collect trees existing in the city and become the biggest owner on the map by buying and locking every trees available. The player receives a wallet with leafs(the game money) at the beginning and this wallet decreases and increase throughout the game. More explanation in the gamerules .
This api has been made by :
How to run the project :
As you are in /server, in your terminal run :
npm i
Open the .env.example in the /server. Rename it .env.
FRONTEND_LOCAHOST=http://localhost:3000 //Insert the localhost or deploy URL for your website
DB_URL=mongodb+srv://<username>:<password>@<your-cluster-url>/test?retryWrites=true&w=majority //Create a server for the DB on MongoAtlas
NODE_TOKEN=yoursecretstring //Choose a string to decrypt the token
NODE_PORT=8080 //Choose the port you want to run your API on
As you are in /server, in your terminal run :
npm run start
You should received :
Open the folder /db
Run the command in your terminal :
node seeder.js
Wait for the datas to seed in your database.
Run the command in your terminal :
node deleteData.js
The command will delete every tree with a value less than 200 and erase every tree with a null value.
→ Node.js
→ MongoDB
- bcrypt (hash the password)
- cors (allows restricted source on the webpage)
- dotenv (read the .env)
- jwt-decode (json token)
- jsonwebtoken (json token)
- mongoose (connect to MongoDB)
- morgan (Error testing logs)
- node-cron (Programs specific action)
- nodemon (Reloading the server)
- project-name-generator (Generate random name)
- validator (Check the authentication fields)
The player need to sign up or log into an existing account to play.
- an username
- an email account
- a secure password
- an unique hexadecimal color (each player has a color in the game).
→ The player received three random tree on the map and an initial amount of leafs(game money) to play. This amounts is the result of the sum of the prices of the three random trees attributed at the beginning.
The leafs increased every 15 minutes by the total of all the tree in his possession at the time. Every hour the player loose half of the leafs his wallet.
The value of the tree is calculated based on his height and diameter in real life. → If the tree is available, pay the value of the tree.
→ If the tree belongs to another player, the price is calculated based on the amount of the trees the players already possess in a radius of 100 meters.
HOWEVER a player can lock a tree, to make it unavailable to buy for others players.
→ The player can add comments to the trees to interact with the community
The player can edit his description and private information and log out anytime he wants.
POST Sign In/ Login = /api/user/signin
POST Sign Up = /api/user/signup
GET Sign Out = /api/user/signout
GET Display account = /api/account/username/insert-username
PATCH Update account = /api/account/username/insert-username
DELETE Delete account = /api/account/username/insert-username
GET Leaderboard (all the players organised by leaf count) = /api/account/leaderboard
GET Display account info + trees the player owns = /api/account/username/tree/insert-username
GET Display all trees infos = /api/tree/all
GET Display one tree and his comments = /api/tree/insert-tree-name
GET Buy a tree = /api/tree/buy/insert-tree-name
GET Get price of a tree = /api/tree/price/insert-tree-name
GET Lock tree = /api/tree/lock/insert-tree-name
GET Unlock tree = /api/tree/unlock/insert-tree-name
POST Create a comment = /api/comment/create/insert-tree-id