galvinguy2002 / zopsmart-gofr-project

A simple GoFr mini project built by a Go getter

Zopsmart GoFr Project

A Simple GoFr Mini Project built by a Go Getter (Stocks Management API) !!

Net Requirements:

Build a simple HTTP (REST) API using GoFr-- (Stocks API)

1. CRUD Operations: Build APIs for create, read, update and delete operations for all entities

• Create ✅

• Read ✅

• Update/Delete ✅

2. DB Integration: The API should have integration with database for persistence of data. Any SQL or NoSQL DB, which has a freely available docker image, may be used

• Database Creation ✅

• Integration using Gofr ✅

3. Unit Tests: A minimum of 60% unit test coverage is desired

• All CRUD op represent approximate unit test coverage ✅

• Try to incorporate a real-world scenario while implementing the project. ✅

  • The real world scenario involves Stock Management API where user can retrieve details in relation with STOCKS. ✅

Extra Points

• Unit Test Coverage > 90%

• Postman collection for trying out the APIs(partially done) ❗✔️

• Sequence diagrams, UML diagrams ✅

• Subtle Front-End components provided for easy understanding ✅

[[ The following sequence diagram represents the outline of the API as complexity of the entire application and the interactions with the gofr package and the database is not possible here. ]]
--> Additional UML Diagram for visual understanding :

How to Run the Stock API:

Prerequisites:

• Ensure you have Go installed on your system. If not, you can download and install it. FOLLOW IN ORDER

1. Clone the Repo

   • Clone the repository containing the Go code for the Movie Management API.

2. Install Dependencies:

   • If your project has any external dependencies, use the following command to install them.

   go get ./...
   -->gofr
   -->npm packages (if req)
   -->go mod tidy/go mod init for tracking

3. Build and Run:

   • Build and run the main.go file. go run main.go

   
   This will start the API server, and it will be accessible at `http://localhost:8000`.
   
   
   

4. Testing with Postman:

   • Install Postman to test the API endpoints.
   • Use Postman to send HTTP requests to the API at http://localhost:8000/stock for testing CRUD operations.

---

Prerequisites For FrontEnd

Make sure you have the following installed on your machine:

• Node.js & npm - Download & Install Node.js
• Git - Download & Install Git

Installation

1. Clone the repository:

   git clone https://github.com/galvinguy2002/Zopsmart-GoFr-Project

2. Navigate to the project directory:

   cd stocks-management-app

3. Install dependencies:

   npm install

Running the Application

To stat the React development server, use the following command:

npm start

🎉 Thanks

Built with :
Golang & GoFr
HAPPY CODING :)

WITH REGARDS TO THE ZOPSMART TEAM
Harshvardhan Saxena
20104064
[email protected]
Jaypee Institute of Information Technology(JIIT), Noida

zopsmart-gofr-project's Issues

sc's