README.md

Encore + Knex TypeScript Example

This is a RESTful API Starter with Knex as ORM to handle database CRUD operations.

Developing locally

When you have installed Encore, you can create a new Encore application and clone this example with this command.

encore app create my-app-name --example=ts/knex

Running locally

encore run

While encore run is running, open http://localhost:9400/ to view Encore's local developer dashboard.

Using the API

Counts and returns the number of existing users

curl 'http://localhost:4000/count/users'

Create a new user

curl 'http://localhost:4000/users' -d '{"name":"John","surname":"Doe"}'

Get all users data

curl 'http://localhost:4000/users'

# for paginated data:
curl 'http://localhost:4000/users?page=1&limit=10'

Get user data by id

curl 'http://localhost:4000/users/:id'

Update user data

# partial update
curl 'http://localhost:4000/users/:id' -d '{"data":{"name":"Johnny"}}'

# update complete data
curl 'http://localhost:4000/users/:id' -d '{"data":{"name":"Mary","surname":"Jane"}}'

Delete an user by id

curl -X DELETE 'http://localhost:4000/users/:id'

Creating Migrations

Migrations are automatically applied when you run your Encore application, so you don’t need to run knex migrate:latest or similar commands manually. You'll have to create and maintain migration files in SQL format.

Deployment

Deploy your application to a staging environment in Encore's free development cloud:

git add -A .
git commit -m 'Commit message'
git push encore

Then head over to the Cloud Dashboard to monitor your deployment and find your production URL.

From there you can also connect your own AWS or GCP account to use for deployment.

Now off you go into the clouds!