This project was bootstrapped with Create React App.
A lot of bootstrapped generators are great but are either too limited or add a lot of junk into the project, here I wanted to create something that would allow me to create a project of any scale using the latest technologies.
This is a template project to contain the complete setup for a full stack TypeScript project. Using the most popular tools this repo aims to make it super quick and easy to get going with an app of any scale as it contains all the basic setup needed for almost any project.
Bootstrapped with the create react app in Typescript the frontend is setup with:
- Redux
- React-Router-Dom
- Styled-components
- TailwindCSS
Tailwind has been fully intergrated into the frontend to allow for a much easier way to deal with the styles, this provides more flexabiity that can be used well alongside styled-components
Tailwind is quickly updated but it is actually pretty simple to update to the latest version. Just update the package in the package.json then remove the current tailwind.js in the root and re-initialize it npx tailwind init tailwind.js --full this will now include all the latest classes.
The backend is using ExpressJS with OvernightJS to better organise the controllers using decorators without having to use a much bigger framework like Nest.
THe database connection is controlled with TypeORM that will is currently setup with mySQL but can easily be switched to any other database supported.
The production build has been Dockerized and is able to be built but will require database values being passed in. This is done with the build arguments as can be seen below.
docker build --file Dockerfile --build-arg DB_HOST=${HOST_ADDRESS} --build-arg DB_USERNAME=${DB_USER} --build-arg DB_PASSWORD=${DB_PASSWORD} --build-arg DB_NAME=${DATABASE} --tag build-tag .
To then run the image the following command can be used:
docker container run --publish 3030:3001 --detach build-1.0
This will run the image from the tag name in detach mode. It will run exposing PORT 3030
in the .env add in the following parameters to connect to the database:
DB_HOST=HOST_ADDRESS
DB_USERNAME=DB_USERNAME
DB_PASSWORD=DB_PASSWORD
DB_NAME=NAME_OF_DATABASE