Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/misterrooster/rooster-board

Message board application with a public board to write messages to. Uses NodeJS, Express, MongoDB & Typescript.
https://github.com/misterrooster/rooster-board

expressjs mongodb mongoose nodejs pugjs server-side-rendering typescript

Last synced: 12 days ago
JSON representation

Message board application with a public board to write messages to. Uses NodeJS, Express, MongoDB & Typescript.

Host: GitHub
URL: https://github.com/misterrooster/rooster-board
Owner: MisterRooster
License: mit
Created: 2023-08-09T20:40:26.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-08-13T18:01:19.000Z (over 1 year ago)
Last Synced: 2024-10-18T01:36:22.553Z (about 1 month ago)
Topics: expressjs, mongodb, mongoose, nodejs, pugjs, server-side-rendering, typescript
Language: CSS
Homepage: https://rooster-board.onrender.com
Size: 241 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Rooster Board

![NodeJS shield](https://img.shields.io/badge/nodejs-339933?logo=nodedotjs&logoColor=white&link=https%3A%2F%2Fnodejs.org%2F)
![Express shield](https://img.shields.io/badge/express-black?logo=express&logoColor=white&link=https%3A%2F%2Fnodejs.org%2F)
![Mongoose shield](https://img.shields.io/badge/mongoose-880000?logo=mongoose&logoColor=white&link=https%3A%2F%2Fnodejs.org%2F)
![TS shield](https://img.shields.io/badge/typescript-3178C6?logo=typescript&logoColor=white&link=https%3A%2F%2Fnodejs.org%2F)

Simple message board using serverside rendering and a database that allows users to write messages on a public board.
Users can create new messages which than gets stored in a MongoDB database instance.

This Projects main purpose was to practice full-stack development. Feel free to use it as an inspiration or as
a learning resource.

## Features:
- Express server with NodeJS
- Serverside rendering via PugJS template engine
- MongoDB database synchronization via mongoose
- Dynamic background rendered on the clientside
- Rate limitation, request compression and form validation checks
- Written in Typescript

## How to run it locally

As a prerequisite you must either have [MongoDB Community Server](https://www.mongodb.com/try/download/community) installed locally or have an MongoDB Atlas account (you can create one for free [here](https://www.mongodb.com/cloud/atlas/register)).
Also make sure to have NodeJS version `18.17.0` or above installed.

After that clone the repository locally (if you havent already):

```bash
git clone [email protected]:MisterRooster/rooster-board.git
```

Then move to the project directory and install dependencies:

```bash
cd rooster-board
npm install
```

Now copy the `.env.example` environment configuration file as `.env` at the root of the project and add your cluster connection string url `DB_URL` (replace your username and password):

```bash
DB_URI=mongodb+srv://:@.mongodb.net/
```
You can optionally change the server port via `PORT`, node environment variable `NODE_ENV` and database name ``DB_NAME` here if you like.
For a local MongoDB installation the string looks like the following (no authentication needed):

```bash
DB_URI=mongodb://127.0.0.1:27017
```

Then build and start the server locally with the following command:

```bash
npm deploy
```

If you want a development server with HMR use:

```bash
npm run dev
```

---