https://github.com/jordanrobo/rest_api_templates
This monorepo is a collection of server templates for building RESTful APIs with basic CRUD (Create, Read, Update, Delete) functionality. The goal is to provide a starting point for various projects that require a server to handle database operations, with each template written in a different language or framework.
https://github.com/jordanrobo/rest_api_templates
Last synced: over 1 year ago
JSON representation
This monorepo is a collection of server templates for building RESTful APIs with basic CRUD (Create, Read, Update, Delete) functionality. The goal is to provide a starting point for various projects that require a server to handle database operations, with each template written in a different language or framework.
- Host: GitHub
- URL: https://github.com/jordanrobo/rest_api_templates
- Owner: JordanRobo
- Created: 2024-04-10T06:34:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T00:53:49.000Z (about 2 years ago)
- Last Synced: 2024-05-10T01:44:05.102Z (about 2 years ago)
- Language: Rust
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rest API Templates Monorepo
This monorepo is a collection of server templates for building RESTful APIs with basic CRUD (Create, Read, Update, Delete) functionality all with a basic SQLite Database. The goal is to provide a starting point for various projects that require a server to handle database operations, with each template written in a different language or framework.
## Overview
The monorepo contains multiple folders, each representing a separate language. Within each language folder are templates using different frameworks. Each template is designed to be self-contained, with its own set of dependencies, setup instructions, and documentation.
The templates currently included are:
### Bun
- **Elysia & Drizzle**: Built with Bun, Elysia JS and Drizzle ORM.
### Go
### Node.js
### Python
### Rust
- **Hyper.rs & SeaORM**: Built with Rust, Hyper.rs and SeaORM.
- **Actix Web & Diesel**: Built with Rust, Actix Web and Diesel ORM.
More server templates will be added to the monorepo over time, covering different languages, frameworks, and database systems.
## Getting Started
To get started with any of the server templates, follow these steps:
1. Navigate to the desired server template folder within the monorepo.
2. Follow the setup instructions provided in the template's README file to install the required dependencies.
3. Run the server using the provided commands.
4. Interact with the API using tools like Postman, curl, or a web browser.
Each server template's README will provide detailed instructions on how to set up the environment, run the server, and use the available API endpoints.
## Contributing
Contributions are welcome! If you'd like to add more server templates to this monorepo, please follow these steps:
1. Fork the repository.
2. Create a new branch for your server template: `git checkout -b my-server-template`.
3. Add your server template files to a new directory within the monorepo.
4. Create a README file for your server template, describing the setup process, usage instructions, and available API endpoints.
5. Commit your changes: `git commit -m "Add my-server-template"`.
6. Push to the branch: `git push origin my-server-template`.
7. Open a pull request on the main repository.
## License
This project is licensed under the [MIT License](LICENSE).