From 1830a4a00bf5cd52942e3bdbc38861b66e9e71a8 Mon Sep 17 00:00:00 2001 From: P J Borowiecki Date: Wed, 23 Aug 2023 23:02:08 +0200 Subject: [PATCH] Update README --- README.md | 173 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 161 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 47b79bf..8bd7be7 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,47 @@ +
+

ARKA

+

Veterinary Clinic Landing Pagen and Appointment Booking System

+

+ Report Bug + ยท + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. About The Project
    2. +
  2. Tech Stack
    3. +
  3. Getting Started
    4. +
  4. Contributing
    5. +
  5. License
    6. +
  6. Contact
    7. +
  7. ToDo
    8. +
+
+ + + ## About the Project [https://arka-weterynaria.pl](https://arka-weterynaria.pl) +
![public/images/screenshot](./public/images/screenshots/screenshot.png) +
-This project is a re-build of the [Arka Weterynaria](https://arka-weterynaria.pl) website I receintly build with [Remix](https://remix.run/) and [MongoDB Atlas](https://www.mongodb.com/atlas/database) for one of my clients in Poland. I decided to re-build it with the latest and greatest in tech for my own learning purposes. This project is still in development. Please check back soon. +This project is a re-build of the [Arka Weterynaria](https://arka-weterynaria.pl) website I receintly build with [Remix](https://remix.run/) and [MongoDB Atlas](https://www.mongodb.com/atlas/database) for one of my clients in Poland. I decided to re-build it with the latest and greatest in tech for my own learning purposes. The original website was desined by me in Figma and built with Remix and MongoDB Atlas. The client wanted a simple website with a contact form and a full booking management system, where he would be able to confirm or reject bookings and notify the client via email. The website is hosted on Vercel. When completed, I intend to replace the original website with this rebuild. -### Tech Stack +**This project is currently in development. Please check back soon.** + +

(back to top)

+
+ +## Tech Stack - **Framework:** [Next.js 13](https://nextjs.org) - **Styling:** [Tailwind CSS](https://tailwindcss.com) @@ -18,22 +51,138 @@ The original website was desined by me in Figma and built with Remix and MongoDB - **Authentication:** [Clerk](https://clerk.com) - **Forms:** [React Hook Form](https://react-hook-form.com) - **Email:** [React Email](https://react.email) -- **Validation:** [Zod](https://zod.dev/) +- **Validations:** [Zod](https://zod.dev/) - **Hosting:** [Vercel](https://vercel.com) +- **Project Management:** [Jira](https://www.atlassian.com/software/jira) + +

(back to top)


+ +## Getting Started

+ +#### Prerequisites: + +- [Node.js (version 18 or higher)](https://nodejs.org) +- [pNPM](https://pnpm.io) (alternatively, you can use npm or yarn) +
+ +#### Installation: + +
+ +1. Clone the repo + + ```sh + git clone https://github.com/pjborowiecki/ARKA-Veterinary-Clinic-Landing-Page-and-Appointment-Booking-System.git + ``` + +
+ +2. Install the required packages + + ```sh + pnpm install + ``` + +
+ +3. Rename a `.env.example` file in the project's root directory and fill in the required values. See below for details on obtaining the keys: +
+ + - **Clerk:**

+ + - Create a new account with [Clerk](https://clerk.com) + - _ToDo:_ Complete the setup instructions

+ + - **PlanetScale:**

+ + - Create a new account with [PlanetScale](https://planetscale.com) + - _ToDo:_ Complete the setup instructions

+ + - **PlanetScale:**

+ + - Create a new account with [Resend](https://resend.com) + - _ToDo:_ Complete the setup instructions

+ +

(back to top)


-### TODO: +#### Development:

+ +1. Start the development server + + ```sh + pnpm dev + ``` + +
+ +2. Your app should be available at [http://localhost:3000](https://localhost:3000) +
+ +

(back to top)


+ +#### Deployment: + +ToDo: Complete the deployment instructions + +

(back to top)

+
+ +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Run code linting (`pnpm lint`) +5. Run code formatting (`pnpm format`) +6. Push to the Branch (`git push origin feature/AmazingFeature`) +7. Open a Pull Request + +

(back to top)

+
+ + + +## License + +Distributed under the MIT License. + +

(back to top)

+ + + +## Contact + +Piotr Borowiecki - [@pjborowiecki](https://www.linkedin.com/in/pjborowiecki/) - hello@pjborowiecki.com + +

(back to top)

+
+ + + +## ToDo - [ ] Fix urls and paths (dashboard, reservations, settings, etc.) +- [ ] Decide on the type of time slots and update the data schema +- [ ] Fix server actions - [ ] Implement the landing page: - - [ ] Add a navbar + - [x] Add navbar - [ ] Add mobile menu - - [ ] Add a hero section - - [ ] Add a services section - - [ ] Add a contact section - - [ ] Add a footer + - [x] Add hero section + - [x] Add about section + - [ ] Add services section + - [ ] Add contact section + - [ ] Add footer - [ ] Investigate the opacity issue (e.g., /10) -- [ ] Add a favicon +- [ ] Add favicon - [ ] Add OpenGRaph image (og.jpg) -- [ ] Add a robots.txt file -- [ ] Add a sitemap.xml file +- [ ] Add robots.txt file +- [ ] Add sitemap.xml file - [ ] Add site description in siteConfig +- [ ] Improve README + +

(back to top)