Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkloz/bulletproof-express
Bulletproof template for express app
https://github.com/mkloz/bulletproof-express
express nodejs openapi prisma rest-api
Last synced: 2 months ago
JSON representation
Bulletproof template for express app
- Host: GitHub
- URL: https://github.com/mkloz/bulletproof-express
- Owner: mkloz
- License: mit
- Created: 2024-05-20T14:46:24.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-27T14:39:08.000Z (5 months ago)
- Last Synced: 2024-08-27T16:11:56.665Z (5 months ago)
- Topics: express, nodejs, openapi, prisma, rest-api
- Language: TypeScript
- Homepage:
- Size: 54.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BULLETPROOF-EXPRESS
Bulletproof template for new express app
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running bulletproof-express](#-running-bulletproof-express)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
---
## 📍 Overview
Maybe the best way to start a new app on express.
Copy -> Adapt -> Start to build with all modern features. It is that simple)
---
## 🚀 Getting Started
### ⚙️ Installation
1. Clone the bulletproof-express repository:
```sh
git clone https://github.com/mkloz/bulletproof-express
```
2. Change to the project directory:
```sh
cd bulletproof-express
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running bulletproof-express
Use the following command to run bulletproof-express:
```sh
npm run build && nmp run start
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/mkloz/bulletproof-express/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/mkloz/bulletproof-express/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/mkloz/bulletproof-express/issues)**: Submit bugs found or log feature requests for Bulletproof-express.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/mkloz/bulletproof-express
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [MIT](https://choosealicense.com/licenses/mit) License. For more details, refer to the [LICENSE](./LICENSE) file.
---