https://github.com/raghu2x/nodejs-api
Rest-api using node.js, express.js and mongoDB with power of typescript
https://github.com/raghu2x/nodejs-api
authentication expressjs mongodb nodejs rest-api typescript
Last synced: 4 months ago
JSON representation
Rest-api using node.js, express.js and mongoDB with power of typescript
- Host: GitHub
- URL: https://github.com/raghu2x/nodejs-api
- Owner: raghu2x
- License: mit
- Created: 2022-12-15T13:43:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T19:28:35.000Z (over 1 year ago)
- Last Synced: 2025-01-07T20:21:17.706Z (over 1 year ago)
- Topics: authentication, expressjs, mongodb, nodejs, rest-api, typescript
- Language: TypeScript
- Homepage: https://nodejs-app-chi.vercel.app
- Size: 439 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nodejs API
Express API structure with the power of typescript
Get latest: [Postman Collection](https://api.postman.com/collections/25705198-746e7237-2acc-468e-b9d8-885dccb47aae?access_key=PMAT-01HGQY7SFFZBZ902KZRBRDP8VG)
## Getting Started
To get started with this project, follow these steps:
### Installation
1. Clone this repository.
2. Navigate to the project folder: `cd project-folder`
3. Install dependencies: `npm install`
4. Set up environment variables.
5. Start the server: `npm run dev`
### Lint the files
```bash
npm run lint #lint files
# or
npm run lint:fix #fix lintinig issues
```
### Build the app for production
```bash
npm run build
```
## Technologies
Outline the technologies, frameworks, and libraries used in your project.
- Node.js
- Typescript
- Express.js
- MongoDB
## Database
This project uses MongoDB for data storage. Ensure you have a MongoDB instance running locally or configure the database connection in your project settings.
## Contributing
We welcome contributions! If you would like to contribute to this project, please follow our contributing guidelines.
## License
This project is licensed under the MIT License. See the LICENSE file for details.