We would like to build a lightweight tool for developers to create micro-services easilyit
- developers should be able to use framework to create micro-services using Restful APIs
- developers can create CRUD APIs very quickly such POST, PUT, UPDATE and UPDATE
- these APIs can process entire lifecycle of http request and response
- we should provide functionality for developers to introduce additional processes such as authinetication into these these APIs
Before you can start working on this project, please make sure you have the following software installed:
To set up the development environment and start working on this project, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/alisherk/micro-maker.git
- Open the project in Visual Studio Code:
cd <project-directory>
code .
- Install the recommended extensions:
- Reopen the project in a devcontainer:
- Press
F1
in Visual Studio Code. - Select "Remote-Containers: Reopen in Container".
This will automatically build and start the devcontainer according to the configuration defined in .devcontainer/devcontainer.json
.
- Start working on the project inside the devcontainer.
The development environment is based on Docker and consists of a pre-configured container with all the necessary tools and dependencies. This ensures consistent development environments across different machines.
To learn more about how the development environment is set up or to customize it, refer to the .devcontainer/devcontainer.json
file.
- Building the devcontainer: If you make changes to the devcontainer configuration or Dockerfile, you can rebuild the devcontainer by selecting "Remote-Containers: Rebuild Container" from the Visual Studio Code command palette.
- Stopping the devcontainer: To stop the devcontainer, you can select "Remote-Containers: Close Remote Connection" from the command palette or close the Visual Studio Code window.
- Connecting to an existing devcontainer: If another developer already set up the devcontainer and you want to connect to it, make sure you have the necessary prerequisites installed and clone the repository. Then, open the project in Visual Studio Code and select "Remote-Containers: Reopen in Container" from the command palette.
If you'd like to contribute to this project, please follow the contribution guidelines.
This project is licensed under the LICENSE NAME.