Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating readMe #23

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 94 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,114 @@
# Getting Started with Create React App
CLINITY
===

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

![](./sc1.png)

Runs the app in the development mode.\
Open [http://localhost:3000](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.
## Summary :
#### ClINITY is a website app created to help people to book an appointment in aclinic online, so any clinic can use this app to organize the reservation time, besides that the client can pick the date and time . doctore can refuse , change or accept date and time
---

### `npm test`
[View project specifications !](https://docs.google.com/document/d/1zSXcCNSuju0yjo6r1XsT2eeDOzfdce5G6oAezfQk198/edit)


[View the project full design !](https://www.figma.com/file/A8X8kPWjWhfR2Hm450HD6o/Projet-1CS---Clinity-(Copy)?node-id=0%3A1)

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
## How use this app as a developer

### `npm run build`
1. git clone the repo
2. run docker compose-up

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
if you have any question don't hesitate to ask :+1:

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
User story
---

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
```gherkin=
As a client, I can serve the website.
As a client, I can reserve an appointment
As a client, I can choose the date of appointment besides the time.
```
```gherkin=
As a doctor, I can view my calendar.
As a doctor, I can accept or refuse an appointment
As a doctor, I can write and extract medical prescriptions.
As a doctor, I can view my daily , weekly and monthly statistics.

### `npm run eject`
```
```gherkin=
As an admin, I can manage accounts.
As an admin, I can view my daily , weekly and monthly statistics.
```

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Class schema
![](./im.png)



Used Technology
---

![](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![](https://img.shields.io/badge/Redux-593D88?style=for-the-badge&logo=redux&logoColor=white)
![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![](https://img.shields.io/badge/nestjs-E0234E?style=for-the-badge&logo=nestjs&logoColor=white)
![](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white)
![](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white)
![](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)

![](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)
![](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E)




availble roles
---
1. admin
2. doctor
3. clinet(PATIENT)
4. doc assistant

Clinity provides
---
- appointement gesture
- accounts gesture
- medical folder gesture
- medical prescription gesture
- medical exams gesture

---
---
If you liked the repo then kindly support it by giving it a star ⭐ and share in your circles so more people can benefit from the effort.

## Contributions Welcome
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](#)

If you find any bug in the code or have any improvements in mind then feel free to generate a pull request.

## Issues
[![GitHub Issues](https://img.shields.io/github/issues/med-zino/clientWeb-1.svg?style=flat&label=Issues&maxAge=2592000)](https://github.com/PROJET-3CS/clientWeb/issues)

If you face any issue, you can create a new issue in the Issues Tab and I will be glad to help you out.




## Contributors

<a href="https://github.com/med-zino/clientWeb-1/graphs/contributors">
<img src="https://contrib.rocks/image?repo=med-zino/clientWeb-1" />
</a>



## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
Binary file added im.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sc1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.