Skip to content

Recipe library built with Next.js, PostgreSQL and Redis, for workshop use

License

Notifications You must be signed in to change notification settings

Aiven-Labs/nextjs-no-netlify

 
 

Repository files navigation

nextjs-no-netlify

This is a fork of the nextjs-netlify repository with the Netlify bits removed. It is intended for use in a workshop to show how to add Netlify use to a repository.

Free quickstart recipe libary app using Next.js, Prisma and Aiven. Recipe data is from kaggle.

About the app

The application is a recipe library where you can browse and inspect recipes. Additionally, you can like recipes that seem interesting and filter list to show only liked ones. Furthermore, you can see interesting statistics from all of the recipes and those that are liked.

PostgreSQL® is used as the data storage for storing all recipes and whether they are liked or not. Aiven for Caching is optional, but when configured statistics are cached to offer faster response time. The database response times are shown in the app to demonstrate the difference. You can get free services with Aiven for PostgreSQL and Aiven for Caching by signing up.

The application is designed to be hosted on serverless application platform Netlify, which has amazing support for hosting Next.js applications.

Getting started

The app requires a PostgreSQL database. Configuring Aiven for Caching is optional, but highly recommended to demonstrate all features of the application and the benefits of having Caching as part of your application. Using us-east-1 region is recommended to minimise latency, as this region will be closest to where the Netlify functions are deployed if using their free plan.

Get free Aiven for PostgreSQL and Aiven for Caching from Aiven.

Development setup

  • Install Node version 18
  • Copy .env.template as .env and set DATABASE_URL and REDIS_URI
  • Install the packages: npm ci
  • Setup the database by running: npm run reset-db
  • Start the development server: npm run dev
  • Go to http://localhost:3000 and head to browse the recipes

Congratulations you can now start developing. The page reloads automatically as you make changes.

Useful commands for development

  • Reset the database: npm run reset-db
  • Run the development server: npm run dev
  • Run eslint: npm run eslint
  • Run prettier format: npm run format

Licenses

nextjs-no-netlify is licensed under the Apache license, version 2.0. Full license text is available in the LICENSE file. Please note that the project explicitly does not require a CLA (Contributor License Agreement) from its contributors.

PostgreSQL is a trademark or registered trademark of the PostgreSQL Community Association of Canada, and used with their permission. *Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by Aiven is for referential purposes only and does not indicate any sponsorship, endorsement or affiliation between Redis and Aiven. All product and service names used in this website are for identification purposes only and do not imply endorsement.

Contact

Bug reports and patches are very welcome, please post them as GitHub issues and pull requests at https://github.com/Aiven-Labs/nextjs-no-netlify.

About

Recipe library built with Next.js, PostgreSQL and Redis, for workshop use

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.4%
  • CSS 1.9%
  • JavaScript 0.7%