Git Product home page Git Product logo

api-deployment-example's Introduction

API Deployment Example

Setup

  1. Make sure Docker is installed and running
  2. Make sure sqlx cli is installed
  3. Create a .env file. This file will store environment variables. Specifically, DATABASE_URL and POSTGRES_PASSWORD. It should look like this: 
    DATABASE_URL=postgres://postgres:postgrespw@localhost:5432
POSTGRES_PASSWORD=postgrespw
    NOTE: When deploying the API, make sure to change the default PostgreSQL password.
  4. Update docker-compose.yml and change letsgetrusty to your own Docker Hub username.

Run Locally

  1. Run an instance of PostgreSQL. This can be done via Docker: 
    docker pull postgres
docker run --name example-db -e POSTGRES_PASSWORD=postgrespw -p 5432:5432 -d postgres
  2. Run SQL migrations: 
    sqlx migrate run
  3. Start server: 
    cargo run
  4. Test routes. I like to use Postman.

Run Locally using Docker

  1. Run API via Docker Compose: 
    docker-compose up
  2. Test routes. I like to use Postman.

api-deployment-example's People

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.