README.md

Rule of Thumb

Rule of Thumb is a full-stack example project built with TypeScript and Next.js, backend with MongoDB and GridFS.

Technologies

Getting Started

Start the server using Docker or lift the server locally. First step install dependencies:

npm ci

Docker

cp .env.example env.docker # Edit the variables

npm run serve # Start a Docker container
npm run seed  # Populate the MongoDB database and load the images to GridFS
npm run stop  # Stop the Docker containers

Local/Remote Database

For a MongoDB running either in localhost or remotely (i.e. Mongo Atlas):

cp .env.local.example env.local # Edit the variables

# Development
npm run dev

# Production
npm run build
npm start

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.