node-express-mongoose-demo - GitLite

KO | EN

gitlite — search

#javascript #typescript #android #machine-learning #deep-learning #docker #macos #nodejs #windows #cli #openai #mcp #ios #open-source

node-express-mongoose-demo

(★ 5,098)

A simple demo app using node and mongodb for beginners (with docker)

File Explorer

Download Latest Version (.zip)

- - test.yml
- FUNDING.yml
- stale.yml
- - articles.js
  - comments.js
  - tags.js
  - users.js
- - index.js
- - article.js
  - user.js
- - 404.pug
  - 422.pug
  - 500.pug
- - development.js
  - production.js
  - test.js
- - authorization.js
  - require-https.js
- - github.js
  - google.js
  - linkedin.js
  - local.js
  - twitter.js
- express.js
- imager.js
- index.js
- passport.js
- routes.js
- - Dockerfile
- wait-for-it.sh
- - app.css
  - bootstrap.min.css
  - bootstrap.min.css.map
  - jquery.tagsinput.css
- - app.js
  - bootstrap.min.js
  - bootstrap.min.js.map
  - jquery.min.js
  - jquery.tagsinput.min.js
- helper.js
- test-articles-create.js
- test-users-create.js
.babelrc
.dockerignore
.env.example
.eslintignore
.eslintrc
.gitignore
CODE_OF_CONDUCT.md
docker-compose.yml
Dockerfile
ecosystem.config.js
fly.toml
LICENSE.txt
package-lock.json
package.json
Procfile
README.md
SECURITY.md
server.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![tests](https://github.com/madhums/node-express-mongoose-demo/actions/workflows/test.yml/badge.svg)](https://github.com/madhums/node-express-mongoose-demo/actions/workflows/test.yml)

# Nodejs Express Mongoose Demo

This is a demo application illustrating various features used in everyday web development, with a fine touch of best practices. The demo app is a blog application where users can signup, create an article, delete an article and add comments etc.

Table of contents:

- [Boilerplate](#boilerplate)
- [Install](#install)
- [Tests](#tests)
- [Docker](#docker)
- [License](#license)

## Boilerplate

Want to build something from scratch? use the [boilerplate](https://github.com/madhums/node-express-mongoose)

* Checkout the [apps that are built using this approach](https://github.com/madhums/node-express-mongoose/wiki/Apps-built-using-this-approach)
* The [wiki](https://github.com/madhums/node-express-mongoose/wiki) is wip, it has some information about the way application is setup.

## Install

```sh
git clone git://github.com/madhums/node-express-mongoose-demo.git
npm install
cp .env.example .env
npm start
```

Then visit [http://localhost:3000/](http://localhost:3000/)

**NOTE:** Do not forget to set the twitter, google, linkedin and github `CLIENT_ID`s and `SECRET`s. In `development` env, you can set the env variables in `.env` and replace the values there. In `production` env, it is not safe to keep the ids and secrets in a file, so you need to set it up via commandline. If you are using heroku checkout how environment variables are set [here](https://devcenter.heroku.com/articles/config-vars).

## Tests

```sh
npm test
```

## Docker

You can also use docker for development. Make sure you run npm install on your host machine so that code linting and everything works fine.

```sh
npm i
cp .env.example .env
```

Start the services

```sh
docker-compose up -d
```

View the logs

```sh
docker-compose logs -f
```

In case you install a npm module while developing, it should also be installed within docker container, to do this first install the module you want with simple `npm i module name`, then run it within docker container

```sh
docker-compose exec node npm i
```

If you make any changes to the file, nodemon should automatically pick up and restart within docker (you can see this in the logs)

To run tests

```sh
docker-compose exec -e MONGODB_URL=mongodb://mongo:27017/noobjs_test node npm test
```

Note that we are overriding the environment variable set in `.env` file because we don't want our data erased by the tests.

Note: The difference between exec and run is that, exec executes the command within the running container and run will spin up a new container to run that command. So if you want to run only the tests without docker-compose up, you may do so by running `docker-compose run -e MONGODB_URL=mongodb://mongo:27017/noobjs_test node npm test`

## License

MIT