Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/falupi22/trekanic
A basic appointment scheduler for a bike workshop.
https://github.com/falupi22/trekanic
chakra-ui expressjs mongoosejs nodejs passportjs react typescript
Last synced: 12 days ago
JSON representation
A basic appointment scheduler for a bike workshop.
- Host: GitHub
- URL: https://github.com/falupi22/trekanic
- Owner: Falupi22
- License: apache-2.0
- Created: 2024-06-26T18:32:43.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-11-07T15:34:10.000Z (13 days ago)
- Last Synced: 2024-11-07T16:35:03.294Z (13 days ago)
- Topics: chakra-ui, expressjs, mongoosejs, nodejs, passportjs, react, typescript
- Language: TypeScript
- Homepage:
- Size: 817 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Trekanic README
Welcome to Trekanic! This README provides all the necessary information about our online platform, which allows exclusive clients to schedule their appointments effortlessly using the internet.
# Screenshots
- Log in 
- Client 
- Admin 
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [User Guide](#user-guide)
- [License](#license)
## Introduction
Trekanic is a premium online scheduling platform designed for exclusive clients who seek convenience and efficiency in managing their appointments. Our mobile-friendly interface ensures that customers can book, modify, and cancel appointments directly from the internet, anytime and anywhere.
## Features
- **Easy Scheduling:** Clients can book appointments with just a few taps.
- **Appointment Management:** Modify or cancel appointments easily.
- **Notifications:** Receive reminders and notifications about changes in your appointments.
- **Exclusive Access:** Only available to verified, exclusive customers.
- **User-Friendly Interface:** Intuitive and easy-to-navigate platform.
## Getting Started
### Prerequisites
Before you begin, ensure you meet the following requirements:
- Node v20.15.0
### Installation
1. Clone the repo
2. `npm install` (containing repo first, then client and server repos)
3. Create a .env for the server, then configure :
- SESSION_SECRET (for the sessions)
- DB_CONNECTION_STRING (your DB)
- PORT (of the server)
- EMAIL (email of the bot that sends notifications)
- PASSWORD (password of the bot that sends notifications)
4. Configure your DB with all the data (appointments are optional) from ./assets/data. There is no data creation besides products and appointments in this app, hence the app assumes that this data exists. Products are auto created when entering a new catalog number when creating a new appointment!
5. Run with the designated scripts in the corresponding package.json file of each subrepo, or run for both subrepos
from the parent folder. For example:
`npm run build:all`
`npm run start:all` (Not for production)
## User Guide
### Booking an Appointment
1. **Log In:** Enter your exclusive client credentials to log in.
2. **Main page:** At the upper right corner of the appointment's list a plus button appears. Click it!
3. **Pick a Date and Time:** Set the values you wish.
4. **Confirm:** Review your appointment details and confirm the booking.
### Modifying an Appointment
1. **Log In:** Enter your exclusive client credentials to log in.
2. **Main page:** Any appointment has a hamburger-like button on the upper right. Hover on it and an edit button will appear. Click it!
3. **Edit:** Make the necessary changes.
4. **Save:** Save your changes.
### Cancelling an Appointment
1. **Log In:** Enter your exclusive client credentials to log in.
2. **Main page:** Any appointment has a hamburger-like button on the upper right. Hover on it and a bin button will appear. Click it!
3. **Cancel:** Select the appointment you wish to cancel and confirm the cancellation.
### Admin Tasks
1. **Log In:** Enter your exclusive client credentials to log in (admin credentials).
2. **Main page:** Use the scheduler to explore appointments. Click on one to edit or delete it.
3. **Edit/Delete:** Set your values, the click edit, or delete the appointment permanently.
4. **Auto Email:** An email will be sent to the email address of the customer regarding the change or cancellation of the appointment.
## License
Trekanic is licensed under the [Apache 2.0](LICENSE).
---
If you have any additional questions or need further assistance, please feel free to reach out to our support team.
[email protected]