This is a template for a simple To Do List web app that consists of a REST API and a simple front end UI.

The app uses NextJS as the foundation that provides the REST API back end and also serves the static front end. Mongoose is used to define the data model and interfaces to the MongoDB database.

This repo can be used as an Adaptable.io Starter. For instructions on using this repo as a template and deploying to the Adaptable Cloud in just a few clicks, check out the Starter Guide.

All of the following instructions assume you are in the repo root directory.

yarn

The app requires a database to store the data for the REST API. You can run a MongoDB cluster on your local development system if you have Docker installed.

To run a MongoDB cluster using Docker:

yarn run mongo-start

To later stop the MongoDB cluster:

WARNING: All data stored in the local cluster will be deleted when the container is stopped. For information on persisting the database data, see the MongoDB Docker README.

yarn run mongo-stop

yarn run start:dev

NOTE: By default, the app listens on port 3000. To use a different port, set the PORT environment variable to the desired port number.

Use a web browser to connect to http://localhost:3000

The app uses the environment variable DATABASE_URL to connect to your MongoDB instance. Ensure that DATABASE_URL is set to the URL for your MongoDB cluster.

yarn run build

yarn run start

# unit tests
yarn run test

# e2e tests
yarn run test:e2e

# test coverage
yarn run test:cov

This project follows the NestJS conventions for file and directory structure. The implementation of the /todos REST API endpoint can be found in src/todoitems/.

The layout and static portions of the front end can be found in public/index.html The dynamic part of the front end is in public/js/client.js.