https://github.com/balnarendrasapa/project_api

Building this REST API for fun. This repo includes implementation in Django and FastAPI. See the Readme for more Information
https://github.com/balnarendrasapa/project_api

api django django-rest-framework fastapi

Last synced: 2 months ago
JSON representation

Building this REST API for fun. This repo includes implementation in Django and FastAPI. See the Readme for more Information

• Host: GitHub
• URL: https://github.com/balnarendrasapa/project_api
• Owner: balnarendrasapa
• License: gpl-3.0
• Created: 2023-09-05T14:56:37.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T21:22:17.000Z (over 2 years ago)
• Last Synced: 2025-06-14T02:09:17.103Z (about 1 year ago)
• Topics: api, django, django-rest-framework, fastapi
• Language: Python
• Homepage:
• Size: 258 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# API 🚀

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/balnarendrasapa/project_api)

[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/balnarendrasapa/project_api)

![GitHub](https://img.shields.io/github/license/balnarendrasapa/project_api)

I am building this project just for fun 😄. This repository contains code for API in django-restframework and in fastapi. For this project, I chose a postgres database 🐘. You don't need to have it installed on your PC. Everything is written in `.devcontainer/docker-compose.yml` file.

## Development setup ⚙️

This repository contains a devcontainer.json file. You can either choose to open this in codespace or build a development environment locally. If you choose to develop locally, make sure to install the `Remote Development` extension in VSCode.

- If you want to open in codespaces, click on the above badge `Open in GitHub Codespaces` 🛠️

- If you want to open in VSCode locally, click on the above badge `Open in Dev Containers` 🛠️

## Pre-Commit Githooks installation 🚦

This is optional. There are two githooks configured for this repository: black formatter ✨ and flake8 linter ❄️. You can install these githooks by running `make dev-install` ⚙️

## Running server 🏃‍♂️

### In Dev Environment 🛠️

- To run the server, run the command `make run`. This starts up both the django API and FastAPI servers. You can access the django API through `localhost:8080` and you can access FastAPI through `localhost:8000` 🚀

- To stop the server, run `make stopserver` ⛔

### Using docker-compose in root 🐳

- To run using docker-compose, cd into the root directory and run `docker-compose up`. This may not be useful for development.

- There is an image available in this repository. If you just want to check this project out, download `other/docker-compose.yml` file and run `docker-compose up` 🐳