This is a barebones template for a web application built with Vite+React, React Router Dom, Tailwind, Eslint, Prettier, Husky, and Docker Compose. It's a starting point for building a modern web application using some of the most popular and widely used web development technologies.
To get started with this template, follow these steps:
- Clone the repository using
git clone https://github.com/rohilsaraf97/wooky-template.git. - Change into the project directory using
cd wooky-template. - Install dependencies using
npm install. - Start the development server using
npm run dev.
This template comes with a Docker Compose configuration file that can be used to build and run the app inside a Docker container. To do this, follow these steps:
- Build the Docker image using
docker compose build. - Start the container using
docker compose up(or)docker compose up -dto start the container in the background. - Access the app in your browser at
http://localhost:3000. - Since the docker-compose file uses volumes, local changes (during development) in the project directory will be reflected in the docker container.
This template uses the following technologies:
- Vite - Build tool and development server for modern web apps.
- React - A JavaScript library for building user interfaces.
- React Router Dom - A routing library for React applications.
- Tailwind CSS - A utility-first CSS framework.
- ESLint - A pluggable and configurable linter for JavaScript and JSX.
- Prettier - An opinionated code formatter.
- Husky - A tool for running Git hooks.
- Docker Compose - A tool for defining and running multi-container Docker applications.
If you find any issues with this template or have suggestions for improvements, please feel free to open an issue or submit a pull request.