Pencil Tech UI

Welcome to the Pencil Tech UI project! This repository contains the frontend for the shopping and scheduling applications that support educators by providing a seamless and intuitive user experience.

Overview

Pencil Tech UI is built with Next.js and Tailwind CSS, providing a modern, responsive, and engaging interface that connects directly with the backend services of Pencil Tech. It serves as the frontend hub for managing shopping and scheduling needs, empowering teachers and administrators with the tools they need.

Getting Started

Follow the steps below to set up the Pencil Tech UI project on your local machine after cloning it from GitHub.

Prerequisites

Ensure you have the following installed:

• Node.js (version 18+ recommended)
• npm (Node Package Manager)

Installation

1. Clone the Repository:

   Clone the Pencil Tech UI project from GitHub:

   git clone git@github.com:Pencil-For-Schools/pencil-tech-ui.git

2. Navigate to the Project Directory:

   Change into the cloned project’s directory:

   cd pencil-tech-ui

3. Install Dependencies:

   Use npm to install the project dependencies:

   Using npm:

   npm install

Running the Development Server

Once the dependencies are installed, start the development server:

npm run dev

You can view the application in your browser at:

http://localhost:3000

Linting and Formatting

Run the following commands to lint and format your code:

• Linting: Check your code for errors.

  Using npm:

  npm run lint

• Formatting: Automatically format your code using Prettier.

  Using npm:

  npm run format

Contributing

We welcome contributions! Please fork the repository, create a new branch, make your changes, and submit a pull request.

Guidelines

• Follow the project's code of conduct.
• Create issues for any bugs or feature requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Special thanks to our contributors and the Pencil Tech community for their support and inspiration.