DEV Community

Cover image for Building the productive tool API with GitHub Copilot
kihuni
kihuni

Posted on

Building the productive tool API with GitHub Copilot

This is a submission for the GitHub Copilot Challenge: New Beginnings

What I Built

With the help of GitHub Copilot, I built the Fresh Slate API, a project management tool that allows users to manage goals, milestones, daily progress, and productivity patterns. The API is built using Django and Django REST Framework, and it includes features such as user authentication, API documentation with Swagger and ReDoc, and JWT-based authentication.

Demo

List All Goals

Image description
Description: This screenshot shows the response of the GET /goals/ endpoint, listing all the goals.

Create a New Goal

Image description
Description: This screenshot shows the request and response of the POST /goals/ endpoint, creating a new goal.

Retrieve a Goal

Image description
Description: This screenshot shows the response of the GET /goals/{id}/ endpoint, retrieving a goal by its ID.

Update a Goal

Image description
Description: This screenshot shows the request and response of the PUT /goals/{id}/ endpoint, updating a goal.

Delete a Goal

Image description
Description: This screenshot shows the request and response of the DELETE /goals/{id}/ endpoint, deleting a goal.

Repo

https://github.com/kihuni/fresh-slate

Copilot Experience

Throughout the development process, I used GitHub Copilot to assist with writing code, generating boilerplate, writing tests, and providing suggestions for API endpoints and configurations. Copilot helped streamline the development process by offering autocomplete suggestions, generating code snippets, and providing documentation links.

Generating boilerplate
Image description

Prompt it to write URLs for the models
Image description

prompt it with the error I faced while running the server
Image description

Writing readme for the project
Image description

GitHub Models

I used GPT4o for the whole build process

Conclusion

Leveraging GitHub Copilot to build the Fresh Slate API was an enlightening experience. Copilot significantly streamlined the development process by providing intelligent code suggestions, generating boilerplate code, and offering solutions to encountered errors. This allowed me to focus more on the core functionality and logic of the application rather than getting bogged down by repetitive tasks. The ability to quickly generate and refine code snippets and receive documentation links and best practices made the development process more efficient and enjoyable. Overall, GitHub Copilot proved to be an invaluable tool in accelerating the development of the Fresh Slate API and enhancing productivity.

Top comments (0)