Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaog23/e-commerce-api
🛒Api Electronic commerce, is a system of buying and selling products or services over the internet.
https://github.com/joaog23/e-commerce-api
e-commerce-project java
Last synced: 21 days ago
JSON representation
🛒Api Electronic commerce, is a system of buying and selling products or services over the internet.
- Host: GitHub
- URL: https://github.com/joaog23/e-commerce-api
- Owner: JoaoG23
- License: mit
- Created: 2024-06-26T19:04:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T20:15:46.000Z (5 months ago)
- Last Synced: 2024-08-02T04:45:14.767Z (5 months ago)
- Topics: e-commerce-project, java
- Language: Java
- Homepage:
- Size: 1.63 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# E-CommerceGet API
API small e-commerce
electronic commerce, is a system of buying and selling products
or services over the internet.
It is a business model that has become very popular due to its convenience and efficiency.
## Technologies Used 🪄
[](https://insomnia.rest/)
[](https://www.java.com/)
[](https://spring.io/projects/spring-boot)
[](https://projectlombok.org/)
[](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools)
[](https://www.redhat.com/en/topics/api/what-is-a-rest-api)
[](https://www.postgresql.org/)
[](https://jwt.io/)
[](https://spring.io/projects/spring-data-jpa)
[](https://spring.io/projects/spring-security)
## Vhat is left To Do?
Functional Requirements! You can see what is left to do! [Click here](./docs/requirements.md).
## How to Install 🔑
To configure the ecommerceget project, follow the instructions below:
#### Backend (Spring Boot);
`DEVELOPER Environment`
1. Enter the backend folder:
```bash
cd /
```
2. Configure the `application.properties` file for the database settings (located in `src/main/resources`):
```properties
# HIBERNATE
spring.datasource.url=jdbc:postgresql://localhost:5432/e-commerce
spring.datasource.username=admin
spring.datasource.password=admin
# SERVER
server.error.include-stacktrace=never
#server.port=8080
server.servlet.contextPath=/api/v1
# TOKENS
api.security.token.secret=${JWT_Secret:joao}
```
3. Build the project with Maven:
```bash
./mvnw clean install
```
4. Start the Spring Boot server:
```bash
./mvnw spring-boot:run
```
`PRODUCTION DOCKER Environment`
1. Create a folder named `db` in this directory.
2. Inside this folder, create two files:
`db.env` with the following information:
```
POSTGRES_USER=username
POSTGRES_PASSWORD=password
```
`init.sql` with the following commands:
-- Replace `username` with the selected application user.
```
CREATE USER e-commerceget;
CREATE DATABASE e-commerceget;
GRANT ALL PRIVILEGES ON DATABASE e-commerceget TO username;
```
3. In the `application-prod.properties` file, update the information to match your database settings:
```
# JPA
spring.datasource.url=jdbc:postgresql://e-commerceget-container:5432/e-commerceget
spring.datasource.username=username
spring.datasource.password=password
# SERVER
server.error.include-stacktrace=never
server.port=8080
server.servlet.contextPath=/api/v1
# TOKENS
api.security.token.secret=${JWT_Secret:joao}
#spring.jpa.hibernate.ddl-auto=update
#spring.jpa.properties.hibernate.jdbc.lab.non_contextual_creation=true
#flyway.ignoreMigrationPatterns="repeatable:missing"
```
4. Now, just run the command `docker-compose up -d` in the root directory.
1. Ensure that the PostgreSQL database is configured and running.
2. In the terminal, navigate to the project's root directory.
3. Run the following command to start the Spring Boot server:
```bash
./mvnw spring-boot:run
```
4. The Spring Boot server will start and be listening for requests on the defined port.
```bash
http://localhost:8081/api/v1/login
```
5. Use the routes and endpoints provided by the server to manage the deployment processes.
1. **Access the Documents Folder**:
- Navigate to the `/docs` folder on your computer.
2. **Locate the Collection File**:
- Find the JSON file named `insomnia.json`.
3. **Open Insomnia**:
- Start Insomnia on your computer.
4. **Import the Collection**:
- Click on the menu icon in the top left corner (three horizontal lines).
- Select "Import/Export".
- Click "Import Data".
- Choose "From File".
- Navigate to the `/docs/collections` folder, select the collection file, and click "Open".
5. **Verify Import**:
- After the import, verify that the collection was added correctly in Insomnia.
Done! The collection should now be available in Insomnia for you to use.
## How to Use 👨🏽🏫
**You can:**
* Register products
* Manage orders
* Manage stock
**Benefits:**
* Centralize the management of products and orders
* Monitor the status of each order
* Facilitate the management of stock
**Usage Example:**
* An online store can use the system to register all available products, manage received orders, and track the delivery status of each order.
* A sales manager can use the system to check which products are selling the most and adjust the stock according to demand.
## Author
João Guilherme 🚀
Made with 🤭 by João Guilherme 👋🏽 Get in touch below!
[](https://www.linkedin.com/in/joaog123/)
[](mailto:[email protected])
## License
[](./LICENSE)