This project is built using the following key technologies:
- Nuxt3 - The Intuitive Vue Framework 🌐
- TypeScript - JavaScript with syntax for types 📜
- TailwindCSS - A utility-first CSS framework for rapidly building custom designs 🎨
- Vueuse - Collection of essential Vue Composition Utilities for Vue 2 and 3 🔧
Before you start developing, please ensure your development environment meets the following requirements:
- Node.js version 18 or higher 📈.
- Package management is strictly limited to
pnpm
📦. - Strict requirements are placed on commit messages. For detailed rules, please refer to our commitlint configuration 📝.
To get the project up and running on your local machine, follow these steps:
-
Clone the repository:
git clone git@github.com:AchoBeta/achobeta-frontend-admin.git cd repository
or
git clone https://github.com/AchoBeta/achobeta-frontend-admin.git cd repository
-
Install dependencies:
pnpm install
-
Start the development server:
pnpm dev
This command will start the server at
http://localhost:3000
. Open the URL in your browser to view the application 🌍.
To build the application for production deployment, run the following command:
pnpm build
This command compiles and minifies your application for optimal performance 💪.
To deploy the application, you can use the provided shell script:
./build.sh
Ensure that the script has executable permissions:
chmod +x build.sh
We welcome contributions! If you'd like to help improve the codebase, please follow our contribution process:
-
Fork the repository: Click on the 'Fork' button at the top right of this page.
-
Create a new branch for your changes:
git checkout -b your-feature-branch
-
Make your changes and commit them:
git commit -m 'Add some feature'
Make sure your commit messages adhere to the guidelines specified in commitlint.config.js 📝.
-
Push to your fork and submit a pull request.
Please ensure your code passes all tests and if possible, cover new functionality with additional tests. This ensures that your contributions can be integrated smoothly 🌟.
Thank you for contributing to Achobeta Recruit Admin Frontend! We look forward to seeing your innovative enhancements! 🎉