Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhettjel/membual-be-final
https://github.com/rhettjel/membual-be-final
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rhettjel/membual-be-final
- Owner: rhettjel
- Created: 2024-06-19T08:21:03.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-19T08:35:34.000Z (6 months ago)
- Last Synced: 2024-12-09T19:43:30.189Z (13 days ago)
- Language: TypeScript
- Homepage: https://membual-be-final.vercel.app
- Size: 4.74 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Express Backend Boilerplate
This boilerplate provides a foundation for building a Node.js backend server using Express. It includes user authentication features such as user signup and signin. Additionally, it is designed to seamlessly deploy on Vercel for easy scalability and hosting.
## Highlights
- User signup: Register new users with unique usernames and passwords.
- User signin: Allow registered users to authenticate and access protected resources.
- User referral: User can refer someone and check if user signup by referral.
- User Authentication: Secure routes and endpoints using JWT (JSON Web Tokens) for authentication.
- Vercel deployment: Optimized for deployment on the Vercel platform for seamless hosting and scalability.
## Technologies Used
- **Node.js**: A JavaScript runtime environment for building scalable and efficient server-side applications.
- **Express.js**: A minimalist web framework for Node.js, providing a robust set of features for web and mobile applications.
- **JWT (JSON Web Tokens)**: A compact, URL-safe means of representing claims to be transferred between two parties. It's used for securing routes and endpoints.
- **Vercel**: A cloud platform for static sites and Serverless Functions, providing seamless deployment and scalability.
## Getting Started
1. **Clone the repository**:
```
git clone https://github.com/dapp-sculptor/node-express-boilerplate.git
```
2. **Install dependencies**:
```
cd your-project
npm install
```
3. **Set up environment variables**:
Create a `.env` file in the root directory of your project and add the following variables:
```
# JWT token secret key
JWT_SECRET =
# DB CONFIGURATION
DB_NAME =
DB_USERNAME =
DB_PASSWORD =
DB_HOST =
DB_PORT =
# PORT
PORT =
```
4. **Start the server**:
```
npm start
```
This will start the server at `http://localhost:9000` by default.
## Usage
- **Signup Endpoint**:
- Endpoint: `POST /api/signup`
- Request body:
```json
{
"username": "example",
"email": "example",
"password": "example",
"encodedReferrer": "example"
}
```
- **Signin Endpoint**:
- Endpoint: `POST /api/signin`
- Request body:
```json
{
"username": "example",
"password": "password"
}
```
## Deployment on Vercel
To deploy your backend on Vercel:
1. Sign up or log in to your Vercel account.
2. Import your project repository.
3. Follow the Vercel deployment instructions.
## 💭 Feedback and Contributing
🙏 Is anyone willing to build more valuable and exciting project, plz contact.
⛏ Let's build it together!! ⛏
### Connect With Me:
[](https://twitter.com/brjpka)
[](mailto:[email protected])
[](https://t.me/mylord1_1)
[](https://join.skype.com/ubWuVGchDEnU)
[](https://discord.com/users/509337382810550280)