-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2a77349
commit e5595bd
Showing
1 changed file
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# ⚕️🧬🔬Curieo Heathcare Search Backend Project 🔍 | ||
|
||
![Current Version](https://img.shields.io/badge/version-v0.1-blue) | ||
![GitHub Org's stars](https://img.shields.io/github/stars/curieo-org) | ||
![Website](https://img.shields.io/website?url=http%3A%2F%2Fcurieo.org%2F) | ||
|
||
|
||
Welcome to Curieo Search, the search engine on a mission to revolutionize how you access healthcare information. Our goal is simple yet ambitious: to be the best healthcare search engine available, offering unparalleled access to accurate, up-to-date, and relevant medical information. | ||
|
||
## Table of Contents | ||
- [Getting Started](#getting-started) | ||
- [Tools Required](#tools-required) | ||
- [Installation](#installation) | ||
- [Running the App](#running-the-app) | ||
- [Deployment](#deployment) | ||
- [Versioning](#versioning) | ||
|
||
## Getting Started | ||
|
||
The project might have multiple branches: `master`, `development`, etc. which can be explained here | ||
|
||
* `master` contains aggregate code of all branches | ||
* `development` contains code under development | ||
|
||
``` | ||
search | ||
├── README.md | ||
├── package.json | ||
├── .gitignore | ||
├── public | ||
│ ├── favicon.ico | ||
│ ├── index.html | ||
│ └── manifest.json | ||
└── app | ||
├── api | ||
│ ├── common | ||
│ ├── endpoints | ||
│ │ ├── search_endpoint.py | ||
│ ├── errors | ||
│ ├── http_error.py | ||
│ ├── if_none_match.py | ||
│ ├── router | ||
│ ├── gzip.py | ||
│ ├── api.py | ||
├── middlewere | ||
├── process_time.py | ||
├── App.js | ||
├── App.test.js | ||
├── index.css | ||
├── index.js | ||
├── logo.svg | ||
└── serviceWorker.js | ||
└── setupTests.js | ||
``` | ||
|
||
### Tools Required | ||
|
||
* A text editor or an IDE (VsCode is Preferred) | ||
|
||
### Installation | ||
|
||
All installation steps go here. | ||
|
||
* Installing a particular tool | ||
* Steps to complete it | ||
|
||
* Installing another tool | ||
|
||
## Running the App | ||
|
||
Steps and commands for running the app are to be included here | ||
|
||
* Example steps: | ||
``` | ||
Example command | ||
``` | ||
|
||
## Deployment | ||
|
||
This section is completely optional. Add additional notes about how to deploy this on a live system | ||
|
||
## Versioning | ||
|
||
`0.0.1` : |