Echo - A Full-Stack Web Application Template

Echo is a Dockerized full-stack TypeScript web application template, built on Strapi, Next.js, PostgreSQL, and nginx. More than just a Docker Compose file, Echo comes pre-configured with useful libraries, CORS configuration, authentication, media uploads, and boilerplate to get you started quickly.

Report Bug · Request Feature

Table of Contents

1. Features
   • Backend
   • Frontend
   • Database
   • Reverse Proxy
   • Containerization
   • Environment Variables
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

Features

Backend

• Strapi v4.22
• Node.js v20.12
• Typescript v5
• Additional Middlewares
  • CORS
  • Media Uploads

Frontend

• Next.js v14.1
• Node.js alpine
• Sass v1.74
• Typescript v5
• Pre-installed libraries
  • Axios
  • Bulma
  • CLSX
  • Date-fns
  • QS
  • React
• Boilerplate
  • Authentication hooks and methods
  • Context-based store and eventbus utilities
  • Strapi REST API and Media Upload helper classes
  • Template control flow utilities

Database

• PostgreSQL v16 alpine
• Apple silicon support
• Named volumes

Reverse Proxy

• nginx latest
• FastCGI
• Extensive mime-type support
• Security configuration

Environment Variables

• Single file for entire stack

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

To run this project you'll need the following software installed:

• git v2.39+
• Node.js v20.12
• Docker v4.28+

Installation

1. Create a copy of this project by using the "Use this template" feature on GitHub, or by forking this repository
2. Clone your copy of the repo git clone https://github.com/<your-username>/<your-app>.git
3. Copy .env.example to .env and fill out all the fields
4. Pull the latest Docker images with npm run pull
5. Run the project with npm run up

The frontend will now be available at http://localhost and the Strapi backend at http://localhost/backend/admin. Make sure port 80 is available for nginx to use.

To run the application in production mode, change ENVIRONMENT=development to ENVIRONMENT=production.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

hello@twocatmoon.com

Project Link: https://github.com/twocatmoon/echo-app

(back to top)