This project is an implementation of an API for domain management using the Go programming language and the lightweight chi router.
- chi Router: A lightweight and fast router for Go, which allows for efficient handling of HTTP requests.
- API Integration: This project integrates with the Simtel's Picast Laravel API for domain management.
- 🌐 View Domain List: Users can see all available domains.
- 🔍 View Domain Details: Ability to retrieve information about a specific domain.
- ➕ Create New Domain: Functionality for adding new domains to the system.
Follow these steps to set up and run the project on your local machine:
-
Clone the Repository:
git clone https://github.com/Simtel/go-project
-
Copy the Configuration File for Local Development:
cp .env .env.local
This file will be used to store your environment settings.
-
Start the Containers: To bring up the required containers, run:
make up
-
Create the Database in Adminer: Once the containers are running, use Adminer to create the database.
-
Run Migrations: Apply migrations to set up the database:
make migrate
-
Run the Project: To start the project, use the following command:
make run
Alternatively, run the project in watch mode for automatic restarts upon code changes:
make watch
-
Run Tests: To execute the tests, run:
make test
GET /domains: Retrieves a list of all domains.GET /domains/{id}: Retrieves details of a specific domain by ID.POST /domains: Creates a new domain.
Feel free to contribute by creating issues or pull requests. To start contributing, please follow these steps:
- Fork the project.
- Create a feature branch.
- Make your changes.
- Commit your changes.
- Push to the branch.
- Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to modify any section according to your specific needs or details about your project!