clauber-camilo / notes-api

notes-api

FIXME

Getting Started

1. Start the application: lein run
2. Go to localhost:8080 to see: Hello World!
3. Read your app's source code at src/notes_api/service.clj. Explore the docs of functions that define routes and responses.
4. Run your app's tests with lein test. Read the tests at test/notes_api/service_test.clj.
5. Learn more! See the Links section below.

Configuration

To configure logging see config/logback.xml. By default, the app logs to stdout and logs/. To learn more about configuring Logback, read its documentation.

To have the basic of the dev environment configured.

Docker

The project contains a basic docker compose file to mount a database. Run the command below to create the postgres instance.

docker-compose up -d

Runnning Migrations

With the database already configured, we now can run the migrations. To be able to run the migration, open the file src/migrations.clj that file contains the lib migratus where the db config is called, and we can evaluate the form (migratus/migrate config) to run the pending migrations.

Developing your service

1. Start a new REPL: lein repl
2. Start your service in dev-mode: (def dev-serv (run-dev))
3. Connect your editor to the running REPL session. Re-evaluated code will be seen immediately in the service.

Docker container support

1. Configure your service to accept incoming connections (edit service.clj and add ::http/host "0.0.0.0" )
2. Build an uberjar of your service: lein uberjar
3. Build a Docker image: sudo docker build -t notes-api .
4. Run your Docker image: docker run -p 8080:8080 notes-api

OSv unikernel support with Capstan

1. Build and run your image: capstan run -f "8080:8080"

Once the image it built, it's cached. To delete the image and build a new one:

1. capstan rmi notes-api; capstan build

Links

• Other Pedestal examples