Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 1.84 KB

README.md

File metadata and controls

53 lines (29 loc) · 1.84 KB

MediLingo

Pitt-Challenge-2023

MediLingo is a relaxed, game-based learning platform for users to explore different medical conditions. It's built with React, TypeScript, and Vite.

Awards

  • Winner - Best Use of MongoDB Atlas at Pitt Challenge 2023
  • Winner - Health Literacy at Pitt Challenge 2023

Client

The client-side of the project is located in the client directory. It's a React application bootstrapped with Vite and TypeScript. The main entry point of the application is client/index.html.

Components

The application's components are located in client/src/components. Each component is a TypeScript React component.

Styles

The application's styles are located in client/src/css.

The application uses Tailwind CSS for styling, configured in client/tailwind.config.js. PostCSS is also used, configured in client/postcss.config.js.

Dependencies and Scripts

The application's dependencies and scripts are defined in client/package.json.

Server

The server-side of the project is located in the server directory. It's a Node.js application with Express.js. The main entry point of the server is server/server.js.

Dependencies and Scripts

The server's dependencies and scripts are defined in server/package.json.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Development

To start the client-side development server, run npm run dev in the client directory.

To start the server-side development server, run npm run dev in the server directory.

Contributing

Contributions are welcome. Please open an issue or submit a pull request on GitHub.

Contact

image For any questions or feedback, please open an issue on GitHub.