Skip to content

maexss/fullstack_basic_starter

 
 

Repository files navigation

Basic Full Stack Architecture Starter

This is a small toy project that I prepared to give some exercises to new colleagues who are approaching web development for the first time, so I can give them a starting point that allows me over time to be able to explain everything to them.

This project integrates the following technologies:

This setup provides a ready-to-use playground for exploring web development concepts and workflows, from frontend UI design to backend services and database interactions.


Getting Started

  1. Create Environment File:

    • Create a .env file in the root directory by renaming .env.placeholder to .env.
    • Fill in the necessary environment variables in the .env file.
  2. Start the Project:

    • To launch the project using Docker, run the following script:
    ./start.sh

    This script will handle all necessary setup and start the services in a containerized environment.

  3. Populate the Database:

    • After starting the project, populate the database by running:
    ./populate.sh

Available URLs

After starting the project, the following URLs will be available:


What's Missing?

The following features and examples are not yet implemented in the current version but can serve as exercises or extensions for developers:

  1. Transaction Example

  2. Backoffice Dashboard

    • Create a functional backoffice dashboard with features like user management, analytics, or content control.

Future Goals

This starter project is intended to evolve with new tools and features. Some potential future enhancements include:

  • Integrating CI/CD workflows.
  • Adding unit and integration testing.
  • Expanding backend functionalities (e.g., file uploads, advanced authentication).
  • Enhancing Docker configuration for production-ready deployment.

Contributing

Contributions are welcome! If you'd like to add features, fix bugs, or enhance the documentation, feel free to fork the repository and submit a pull request.


License

This project is licensed under the MIT License. Feel free to use, modify, and distribute as needed.


About

based on fullstack_basic_starter AndreaGiulianini

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 78.8%
  • CSS 17.0%
  • Dockerfile 2.4%
  • Other 1.8%