Skip to content

Commit 359d180

Browse files
authored
Update README.md
1 parent 355dde0 commit 359d180

File tree

1 file changed

+68
-2
lines changed

1 file changed

+68
-2
lines changed

Diff for: README.md

+68-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,68 @@
1-
# servitium
2-
An all purpose assistance platform where users can get the help they require for their essential everyday services
1+
# Servitium
2+
3+
## Simplifying home services for senior citizens
4+
5+
### Inspiration
6+
Our inspiration for Servitium comes from a deep commitment to enhancing the lives of senior citizens by providing a centralized hub for essential services tailored to their unique needs.
7+
8+
### What it does
9+
Servitium serves as a comprehensive service hub specifically designed for senior citizens. It streamlines access to various services, making daily tasks and support more accessible and efficient.
10+
11+
Demo link: https://www.youtube.com/watch?v=zf_Y6b9uc1c&ab_channel=Kai
12+
13+
Users are provided with a user-friendly interface for finding services that fit their needs. The application also supports the use of natural language to find services (e.g., users can enter "I would like to find an affordable plumber" in the home search bar).
14+
15+
Users can also leave reviews for service providers, making it easier for other users to find the service providers that best suit their needs.
16+
17+
### How we built it
18+
Our platform integrates user-friendly interfaces and secure backend systems to ensure a seamless experience for both users and service providers.
19+
20+
- **Front-end:** React
21+
- **Back-end:** Node.js, MongoDB
22+
- **Authentication:** Auth0
23+
- **APIs used:** OpenAI, Google Maps, Google Places, Nodemailer, Twilio
24+
25+
### Challenges we ran into
26+
- Integrating OpenAI's API to the client-side of the application
27+
- Integrating Nodemailer into the back-end of the application
28+
29+
### Accomplishments that we're proud of
30+
- Integrating AI into our stack - users can use natural language to find services
31+
- Connecting back-end and front-end of our application
32+
- Making use of Auth0 to provide authentication
33+
- Introducing real-time texting and emailing notification features
34+
35+
### What we learned
36+
- Using third-party APIs
37+
- Full-stack development (working on both the server and the client side)
38+
- How to set up and leverage MongoDB
39+
40+
### What's next for Servitium
41+
- Setting up the service provider side of the application since the application currently only supports the client-side
42+
- Retrieving more data on the service provider side (e.g., geolocation)
43+
44+
---
45+
46+
## Installation and Setup Instructions
47+
48+
### Backend
49+
1. Navigate to the `backend` folder.
50+
2. Run `npm install` to install dependencies.
51+
3. Run `npm start` to start the server.
52+
53+
### Frontend
54+
1. Navigate to the `frontend` folder.
55+
2. Run `npm install` to install dependencies.
56+
3. Run `npm run dev` to launch the application.
57+
58+
Once both the backend and frontend servers are running, you can access the application at `localhost:5173`.
59+
60+
## Contact
61+
62+
- Nariman Muldashev - [email protected]
63+
- Benny Li - [email protected]
64+
- Kai Groden-Gilchrist - [email protected]
65+
66+
Devpost Link: https://devpost.com/software/servitium?ref_content=my-projects-tab&ref_feature=my_projects
67+
68+

0 commit comments

Comments
 (0)