Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alextim/nest-test-app
https://github.com/alextim/nest-test-app
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alextim/nest-test-app
- Owner: alextim
- License: mit
- Created: 2022-12-12T21:18:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:54:58.000Z (about 1 year ago)
- Last Synced: 2024-10-30T21:08:15.827Z (2 months ago)
- Language: JavaScript
- Size: 3.86 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS + Mongoose + MongoDB Starter Template
## setup
```env
SESSION_COOKIE_DOMAIN=.example.com
```
or leave it empty
```env
SESSION_COOKIE_DOMAIN=
```
https://github.com/zainuddin25/NestJS-Rest-API/blob/main/src/health/health.controller.ts
https://github.com/gabrielmaialva33/base-nest-api/blob/master/src/modules/health/health.controller.ts
duplicate primary column https://github.com/nestjsx/crud/issues/777
=================================================================
https://github.com/mwanago/nestjs-server-sessions
https://dev.to/nestjs/setting-up-sessions-with-nestjs-passport-and-redis-210
https://betterprogramming.pub/nest-js-project-with-typeorm-and-postgres-ce6b5afac3be
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](https://nextjs.com) as the foundation that provides the REST API back end and also serves the static front end.
[Mongoose](https://mongoosejs.com) is used to define the data model and interfaces to the [MongoDB](https://mongodb.com) database.
## Using this Starter Template
This repo can be used as an [Adaptable.io](https://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](https://adaptable.io/docs/starters/nestjs-mongo-starter).
## Running a local dev environment
All of the following instructions assume you are in the repo root directory.
### 1. Install Node.js modules
```console
yarn
```
### 2. Run MongoDB locally
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:
```console
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](https://github.com/docker-library/docs/blob/master/mongo/README.md#where-to-store-data).
```console
yarn run mongo-stop
```
### 3. Start the app (watch mode)
```console
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.
### 4. Connect to your app
Use a web browser to connect to [http://localhost:3000](http://localhost:3000)
## Running in production
### 1. Set DATABASE_URL
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.
### 2. Build
```console
yarn run build
```
### 3. Run
```console
yarn run start
```
## Testing
```console
# unit tests
yarn run test
# e2e tests
yarn run test:e2e
# test coverage
yarn run test:cov
```
## Source Code
### REST API (back end)
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/`.
### Web UI (front end)
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`.
