This is a CRUD app with additional useful information and automated tasks to help in day-to-day job activities.
To get a local copy up and running, follow these simple steps.
- Node.js version 18.0.0 or higher
- npm version 8.0.0 or higher (optional)
- pnpm version 8.0.0 or higher (preferred)
- Clone the repository
git clone https://github.com/your-username/quick-reference.git
- Navigate into the project directory
cd quick-reference - Install the dependencies using pnpm (preferred)
or with npm (optional)
pnpm install
npm install
To run the application in development mode, use the following command:
pnpm devThis will start a development server, and you can access the application at http://localhost:3000.
Here's an explanation of the scripts within this project:
pnpm start- Starts the application using Node.pnpm dev- Starts the application in development mode with hot-reloading.pnpm lint- Lints the code in thesrcdirectory and fixes any auto-fixable issues.pnpm build- Creates a production build.pnpm serve- Serves the production build for preview.pnpm format- Formats the code in thesrcdirectory using Prettier.pnpm todo- Runs a script to scrape to-dos.pnpm clean- Removes thedistdirectory,node_modules, and prunes the pnpm store.
Any contributions are greatly appreciated. For major changes, please open an issue first to discuss what you would like to change.
- Fork the project
- Create your feature branch (
git checkout -b feature/NewFeature) - Commit your changes (
git commit -m 'Add some NewFeature') - Push to the branch (
git push origin feature/NewFeature) - Open a pull request
- Olen Latham
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions, feel free to reach out to the author or open an issue on GitHub.