api-deployment-example's Introduction

API Deployment Example

Setup

Make sure Docker is installed and running
Make sure sqlx cli is installed
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.
Update docker-compose.yml and change letsgetrusty to your own Docker Hub username.

Run Locally

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

Run SQL migrations:
```
sqlx migrate run
```
Start server:
```
cargo run
```
Test routes. I like to use Postman.

Run Locally using Docker

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

Recommend Projects

React

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

Vue.js

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

Typescript

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

TensorFlow

An Open Source Machine Learning Framework for Everyone

Django

The Web framework for perfectionists with deadlines.

Laravel

A PHP framework for web artisans

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.

Visualization

Some thing interesting about visualization, use data art

Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Microsoft

Open source projects and samples from Microsoft.

Google

Google ❤️ Open Source for everyone.

Alibaba

Alibaba Open Source for everyone

D3

Data-Driven Documents codes.

Tencent

China tencent open source team.

letsgetrusty / api-deployment-example Goto Github PK