Skip to content

ana-pagnoncelli/Scheduler

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Welcome to the Scheduler

This is an awesome platform to use in your business to schedule classes or appointments, show your products, and share important messages with the clients.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

Clinics, pilates studios, beauty salons, and other businesses that rely on appointments and class schedules can greatly benefit from a platform like Scheduler. With Scheduler, businesses can manage their schedules more efficiently, freeing up time to focus on other important tasks.

For example, a pilates studio could use Scheduler to manage its class schedules, allow clients to book, change, or cancel appointments online, post notices or announcements, and send automated notifications to clients. Another interesting feature is the product showcase, where you can display classes, clothes, and accessories.

By using a platform like Scheduler, businesses can save time and reduce the risk of scheduling errors or missed appointments. They can also provide a more convenient and flexible experience for their clients, who can book and manage appointments on their own time. Overall, Scheduler can be a valuable tool for businesses of all types that rely on appointments and schedules to manage their operations.

(back to top)

Built With

  • React
  • Typescript

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is a list of things you need to use the software and how to install them.

  • node v17.8.0
    npm install node@v17.8.0
  • If you already have node installed on your machine, you must change the version after executing the previous command.
    nvm use v17.8.0

Installation

This is how you clone the repository and add all the dependencies.

  1. Clone the repo
    git clone https://github.com/Ana2877/Scheduler.git
  2. Install NPM packages
    npm install

(back to top)

Usage

Here you are going to find some tools/features the project has and how to use them.

(back to top)

How to run the project and basic scripts

  • To run the project:

    npm run start 

    Runs the app in the development mode.
    Open http://localhost:3000 to view it in the browser.

    The page will reload if you make edits.
    You will also see any lint errors in the console.

  • To test the code:

    npm run test

    Launches the test runner in the interactive watch mode.

  • To lint the code:

    npm run lint

    Check if the code is within the eslint rules.

Cypress

Remember to run the project in another terminal before running these commands. We need to do this because the e2e tests are done by accessing the website in the browser by the url.

  • To run the tests hiding the browser:

    npm run cy 

    It is only going to run in your terminal and not open anything else.

  • To run the tests displaying the browser:

    npm run cy:headed

    It is going to open the browser displaying all the tests.

  • To open the cypress:

    npm run cy:open

    Opens Cypress and runs it until you finish the process. Here you have a lot of functionalities, like checking all the tests you have and running specific tests however many times you like.

Storybook

Husky

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

(back to top)

Contact

Ana Pagnoncelli - Likedin - ana.carol.p@hotmail.com

Project Link: https://github.com/Ana2877/Scheduler

(back to top)

Acknowledgments

This space lists resources that I find helpful and would like to give credit to.

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages