https://github.com/muhdhanish/encode_server
Welcome to the Encode Learning App back end repository! This is the server-side of our application, built with Node.js, Express, TypeScript, and MongoDB.
https://github.com/muhdhanish/encode_server
chat clean-architecture controllers expressjs javascript jwt-bearer-tokens mern-stack middleware models mongodb mongoose node-cache nodejs nodemailer otp-verification rest-api router socket-io typescript
Last synced: 4 months ago
JSON representation
Welcome to the Encode Learning App back end repository! This is the server-side of our application, built with Node.js, Express, TypeScript, and MongoDB.
- Host: GitHub
- URL: https://github.com/muhdhanish/encode_server
- Owner: MuhdHanish
- License: mit
- Created: 2023-07-10T05:10:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T12:37:43.000Z (over 1 year ago)
- Last Synced: 2025-04-04T19:41:29.504Z (9 months ago)
- Topics: chat, clean-architecture, controllers, expressjs, javascript, jwt-bearer-tokens, mern-stack, middleware, models, mongodb, mongoose, node-cache, nodejs, nodemailer, otp-verification, rest-api, router, socket-io, typescript
- Language: TypeScript
- Homepage:
- Size: 236 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Encode Learning App - Back End
Welcome to the Encode Learning App back end repository! This is the server-side of our application, built with Node.js, Express, TypeScript, and MongoDB.
## Prerequisites
Before you start, make sure you have the following tools and services set up:
- Node.js (v14 or higher)
- npm (Node Package Manager)
- Git
- MongoDB (You should have an active MongoDB instance or use a cloud-based solution like MongoDB Atlas)
## Getting Started
1. Clone the repository:
git clone https://github.com/MuhdHanish/En-Code-Server.git
2. Navigate to the project directory:
3. Install dependencies:
npm install
4. Start the server:
npm run dev
The server will start running on the specified port (default is 8000).
## Environment Variables
To run the Encode Learning App back end properly, you need to set up the following environment variables. Create a `.env` file in the root of your project and add the following:
```env
SENDER_EMAIL="Sender email address"
SENDER_PASSWORD="Sender email's one time password"
JWT_ACCESS_SECRET="Access secret create own"
JWT_REFRESH_SECRET="Refresh secret create own"
CLIENT_ORIGIN_URL="Client side deplyed url with customised domain"
DISTRIBUTED_ORIGIN_URL="If deployed on cloudfront service"
MONGO_CLOUD_URI="Mongo db cloud uri"
```
## Contributing
We welcome contributions from the community to help make Encode Learning App even better! If you'd like to contribute to this project, please follow our [Contributing Guidelines](CONTRIBUTING.md).
Here's how you can get started:
1. Fork this repository.
2. Clone your forked repository:
## License
This project is licensed under the [MIT License](LICENSE).