https://github.com/colburncodes/podverse
https://github.com/colburncodes/podverse
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/colburncodes/podverse
- Owner: colburncodes
- Created: 2023-10-05T02:17:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-24T02:24:48.000Z (over 2 years ago)
- Last Synced: 2024-12-15T20:14:45.220Z (over 1 year ago)
- Language: TypeScript
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Podverse
Creating a server for the mobile application of Podverse.
## Badges
[](https://choosealicense.com/licenses/mit/)
## Features
- User Registration
- User Login
- Authorization with middleware
- Authentication with JSON web tokens.
- Email Integration using [Mail Trap](https://mailtrap.io/) and [Beefree](https://beefree.io/)
## Tech Stack
**Server:** Node, Express, Mongoose, NodeMailer
## Podverse API Explorer
| Endpoint | Methods | Description |
| -------- | ------- | ----------- |
| `auth/create` | `POST` | Create a new user|
| `auth/verify-email` | `POST` | Verify user's email|
| `auth/send-verify-email` | `POST` | Verification token to validate user|
## Run Locally
Clone the project
```bash
git clone https://github.com/colburncodes/podverse
```
Go to the project directory
```bash
cd podverse
```
Install dependencies
```bash
npm install
```
Create a `.env` file in root directory
```
MONGODB_URI="mongodb://localhost:27017/"
MAILTRAP_USER=
MAILTRAP_PASS=
```
Start the server
```bash
npm run start to launch the server
```
```bash
npm run dev to launch the server with the hot reload feature
```