epiTrello is a Trello-like application built with Nuxt 3. It allows users to manage workspaces, boards, lists, and cards in an intuitive and responsive interface. This README provides an overview of the project, setup instructions, and guidelines for development and production.
- Project Overview
- Setup
- Development
- Production
- Testing
- Deployment
- Additional Resources
- Contributing
- License
epiTrello is designed to offer a project management tool with features similar to Trello. Users can create and organize tasks into boards and lists, and track progress visually. This project leverages Nuxt 3 for its modern framework and server-side rendering capabilities.
To get started with epiTrello, you'll need to install the project dependencies. You can use one of the following package managers:
# npm
npm install
# pnpm
pnpm install
# yarn
yarn install
# bun
bun install
Start the development server to work on the application locally:
# npm
npm run dev
# pnpm
pnpm run dev
# yarn
yarn dev
# bun
bun run dev
The application will be available at http://localhost:3000.
To build the application for production, use the following command:
# npm
npm run build
# pnpm
pnpm run build
# yarn
yarn build
# bun
bun run build
After building, you can preview the production build locally with:
# npm
npm run preview
# pnpm
pnpm run preview
# yarn
yarn preview
# bun
bun run preview
To ensure the quality and reliability of the application, run the tests using the command:
# npm
npm test
# pnpm
pnpm test
# yarn
yarn test
# bun
bun test
Make sure you have set up your testing environment and have the necessary test scripts defined in your package.json.
For deployment, follow the Nuxt 3 deployment documentation. You can deploy the application to various hosting platforms such as Vercel, Netlify, or a custom server.
This project is part of Epitech School 5-years program