https://github.com/novqigarrix/delivery-app
A Backend Server based on RESTfull API using Node.js and Typescript
https://github.com/novqigarrix/delivery-app
express typescript zod
Last synced: 2 months ago
JSON representation
A Backend Server based on RESTfull API using Node.js and Typescript
- Host: GitHub
- URL: https://github.com/novqigarrix/delivery-app
- Owner: NovqiGarrix
- Created: 2021-12-09T06:48:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-22T04:05:14.000Z (over 4 years ago)
- Last Synced: 2026-01-03T12:26:32.887Z (5 months ago)
- Topics: express, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 45.9 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Backend Server based on RESTfull API using Node.js and Typescript
## Getting Started
### # ENV Variables
1. Create a .env file
Create a .env file in the root directory. See .env.example for variables naming!
2. Generate Public and Private keys
``Public and private key are used to generate JWT Tokens more securely``.
You can easily generate them in here
https://app.id123.io/free-tools/key-generator/.
After that, encode both private and public keys to base64 and update .env file's variables values with the encoded public and private keys, based on .env.example variables naming!
3. Getting MongoDb URL Connection
If you are using MongoDb in you local computer, the regular url connection is ``mongodb://127.0.0.1:27017/database_name``. You can change ```database_name``` with your project name, for example ``tiktok-server``, so the url connection will be ```mongodb://127.0.0.1:27017/tiktok-server```.
But, if you are using MongoDb with Atlas, you can get the url connection from your Atlas account.
Check out this tutorial to do so: https://medium.com/@sergio13prez/connecting-to-mongodb-atlas-d1381f184369
### # Install All The Dependencies
Open up your terminal, and type
```yarn```, if you are using yarn
```npm install```, if you are using npm.
## # Run the Server
Open up your terminal, and type
```yarn dev```, if you are using yarn
```npm run dev```, if you are using npm.
## # Build the Server
Open up your terminal, and type
```yarn build```, if you are using yarn
```npm run build```, if you are using npm.
## # That's it.
If you have any doubts or errors, please post it in issues!. I'd love to read and solve it!.
Thanks, ``Novrii``