Code Monkey home page Code Monkey logo

pet-projects-api's Introduction

Pet Projects API

License tests codecov

An API to aggregate personal projects.

Features

  • CRUD operations
  • Authentication with JWT
  • Layered Architecture
  • Custom exceptions and handlers
  • Database migrations with Alembic
  • Management commands with Typer
  • Dockenized app running PostgreSQL and pgAdmin
  • Tests with Pytest
  • Continuous Integration with Github Actions
  • Continuous Deployment at Heroku

Live Preview

See the live preview deployed at Heroku. pet-projects-api

Getting Started

Prerequisites

Setup

  1. Clone this repository:
git clone [email protected]:diogo-alves/pet-projects-api.git
  1. Go to the project directory:
cd pet-projects-api
  1. Install the project dependencies:
make install
  1. Create an .env¹ file based on .env.example . To generate the SECRET_KEY run:
make secret-key

¹ NOTE: By running the app locally, you can set DATABASE_URL to use SQLite without having to install a database system.

Running

Locally

make local

With Docker

make docker

Tests

make tests

View in Browser

Management Commands

To see all commands type:

make commands

API Documentation

License

This project is under the terms of the MIT license.

pet-projects-api's People

Contributors

diogo-alves avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

tuxaco brahimmade

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.