Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsminar/express-mongodb-starter
Boost your Backend Development with this streamlined Boilerplate, crafted for rapid API creation using Express.js and Mongoose, seamlessly working with MongoDB.
https://github.com/itsminar/express-mongodb-starter
expressjs javascript mongodb mongoose nodejs
Last synced: 21 days ago
JSON representation
Boost your Backend Development with this streamlined Boilerplate, crafted for rapid API creation using Express.js and Mongoose, seamlessly working with MongoDB.
- Host: GitHub
- URL: https://github.com/itsminar/express-mongodb-starter
- Owner: itsMinar
- Created: 2024-02-16T14:14:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T17:14:32.000Z (about 1 month ago)
- Last Synced: 2024-11-10T18:21:53.885Z (about 1 month ago)
- Topics: expressjs, javascript, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Expressjs + MongoDB
## When you use this template, make sure that you CHANGE the author name from package.json file and edit this README.md file.
### 💻 Environment setup for Running Locally
To Use this Starter Template locally, follow these steps:
1. Install [NodeJs](https://www.nodejs.org/), [MongoDB](https://www.mongodb.com) and [MongoDB Compass (optional)](https://www.mongodb.com/products/compass) on your machine.
2. Clone the project repository:
```bash
git clone https://github.com/itsMinar/express-mongodb-starter.git
```
3. Navigate to the project directory.
```bash
cd express-mongodb-starter
```
4. Remove the git initialization (.git) file (don't use powershell) -
```sh
rm -rf .git*
```
5. #### Create `.env` file in the root folder and copy paste the content of `.env.sample`, and add necessary credentials.
6. Install the packages:
```bash
npm install
```
7. Run the project (Development):
```bash
npm run dev
```
8. Access the APIs at the specified endpoints.
## 💻 Deploy on Vercel for Free
### To Deploy this app for free on Vercel, follow these steps:
1. Create `vercel.json` file in the root folder and copy paste the content given bellow:
```bash
{
"version": 2,
"builds": [
{
"src": "src/index.js",
"use": "@vercel/node"
}
],
"routes": [
{
"src": "/(.*)",
"dest": "src/index.js"
}
]
}
```