Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supitsdu/satur-api
A experimental API for my personal project. Exploring Go, Gorilla Mux, Mongodb, Kubernets, and more.
https://github.com/supitsdu/satur-api
api experimental learning-by-doing microservices mockup-api mongodb
Last synced: 7 days ago
JSON representation
A experimental API for my personal project. Exploring Go, Gorilla Mux, Mongodb, Kubernets, and more.
- Host: GitHub
- URL: https://github.com/supitsdu/satur-api
- Owner: supitsdu
- License: mit
- Created: 2024-04-30T20:24:05.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-03T10:13:16.000Z (7 months ago)
- Last Synced: 2024-05-03T14:42:34.346Z (7 months ago)
- Topics: api, experimental, learning-by-doing, microservices, mockup-api, mongodb
- Language: Go
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Satur API
Satur API is a project aimed at building a robust and efficient API using the Go programming language. It serves as a personal web development mockup project with the primary goal of learning and implementing best practices for API development.
> [!WARNING]
> **Experimental Project**: Please note that Satur API is an experimental project created with a learn-by-doing approach. While efforts have been made to ensure its functionality and stability, it may contain bugs or unforeseen issues. Use it with caution.
## Dependencies
- Go >= 1.22
- Make >= 4.4.1
## Getting Started
To get started with the Satur API, follow these steps:
1. **Clone the Repository**: Clone the Satur API repository to your local machine:
```sh
git clone https://github.com/supitsdu/satur-api.git
```
2. **Install Dependencies**: Navigate to the project directory and run the following command to fetch or manage dependencies:
```sh
make deps
```
3. **Create Environment Variables**: Before running the API, create a `.env` file in the project root directory with the following variables:
```sh
MONGODB_URI=
MONGODB_ID=
SERVER_ADDRESS=localhost:8080
```
Replace `` and `` with your MongoDB connection details.
4. **Run the API**: Once the dependencies are installed and the `.env` file is configured, execute the following command to run the API:
```sh
make run
```
This will start the API server, allowing you to interact with it locally.
## Contributing
Contributions to the Satur API project are welcome! If you find any bugs, have feature requests, or want to contribute code, please open an issue or submit a pull request on the [GitHub repository](https://github.com/supitsdu/satur-api).
## License
Satur API is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute the code for your own projects.