-
Notifications
You must be signed in to change notification settings - Fork 6
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
0 parents
commit 97ef5ca
Showing
20 changed files
with
18,730 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,2 @@ | ||
node_modules | ||
|
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,128 @@ | ||
# SkinAI | ||
|
||
**SkinAI** is an AI-powered web application designed to analyze skin conditions and provide immediate insights and precautions based on the analysis. This application serves as a preliminary tool to help users understand potential skin issues and encourages them to seek professional medical advice. | ||
|
||
## Table of Contents | ||
- [Introduction](#introduction) | ||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Technologies](#technologies) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
- [Contact](#contact) | ||
|
||
## Introduction | ||
|
||
**SkinAI** leverages the MERN (MongoDB, Express.js, React, Node.js) stack and integrates a machine learning service to provide users with insightful analysis of their skin conditions based on uploaded images. | ||
|
||
## Features | ||
|
||
- **User Authentication**: Secure user registration and login. | ||
- **Image Upload**: Upload images of skin for analysis. | ||
- **AI-Powered Analysis**: Analyze uploaded images using a trained machine learning model. | ||
- **Detailed Reports**: Provide users with detailed analysis reports and preliminary suggestions. | ||
- **History Tracking**: Keep track of all past uploads and analysis results for each user. | ||
|
||
## Installation | ||
|
||
### Prerequisites | ||
|
||
- Node.js and npm | ||
- MongoDB | ||
- Python (for the ML service) | ||
|
||
### Backend (Node.js + Express) | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/yourusername/SkinAI.git | ||
cd SkinAI | ||
``` | ||
|
||
2. Install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. Set up environment variables: | ||
Create a `.env` file in the root directory and add the following: | ||
```plaintext | ||
PORT=5000 | ||
MONGO_URI=your_mongodb_uri | ||
``` | ||
|
||
4. Start the server: | ||
```bash | ||
npm start | ||
``` | ||
|
||
### Frontend (React) | ||
|
||
1. Navigate to the `client` directory: | ||
```bash | ||
cd client | ||
``` | ||
|
||
2. Install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. Start the React development server: | ||
```bash | ||
npm start | ||
``` | ||
|
||
### Machine Learning Service (Flask) | ||
|
||
1. Navigate to the `ml-service` directory: | ||
```bash | ||
cd ml-service | ||
``` | ||
|
||
2. Set up a virtual environment and install dependencies: | ||
```bash | ||
python -m venv venv | ||
source venv/bin/activate | ||
pip install -r requirements.txt | ||
``` | ||
|
||
3. Start the Flask server: | ||
```bash | ||
python app.py | ||
``` | ||
|
||
## Usage | ||
|
||
1. Register and log in to the application. | ||
2. Upload an image of your skin through the provided interface. | ||
3. Wait for the AI-powered analysis to complete. | ||
4. View the detailed analysis report and recommendations. | ||
|
||
## Technologies | ||
|
||
- **Frontend**: React | ||
- **Backend**: Node.js, Express.js | ||
- **Database**: MongoDB | ||
- **Machine Learning**: TensorFlow (or PyTorch) | ||
- **ML API**: Flask | ||
|
||
## Contributing | ||
|
||
We welcome contributions from the community! Please follow these steps to contribute: | ||
|
||
1. Fork the repository. | ||
2. Create a new branch (`git checkout -b feature/your-feature`). | ||
3. Make your changes. | ||
4. Commit your changes (`git commit -m 'Add some feature'`). | ||
5. Push to the branch (`git push origin feature/your-feature`). | ||
6. Open a pull request. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. | ||
|
||
## Contact | ||
|
||
For any inquiries, please contact us at [[email protected]](mailto:[email protected]). |
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,23 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
|
||
# testing | ||
/coverage | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
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,70 @@ | ||
# Getting Started with Create React App | ||
|
||
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` | ||
|
||
Runs the app in the development mode.\ | ||
Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
|
||
The page will reload when you make changes.\ | ||
You may also see any lint errors in the console. | ||
|
||
### `npm test` | ||
|
||
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. | ||
|
||
### `npm run build` | ||
|
||
Builds the app for production to the `build` folder.\ | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
||
The build is minified and the filenames include the hashes.\ | ||
Your app is ready to be deployed! | ||
|
||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
||
### `npm run eject` | ||
|
||
**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. | ||
|
||
## 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/). | ||
|
||
### Code Splitting | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) | ||
|
||
### Analyzing the Bundle Size | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) | ||
|
||
### Making a Progressive Web App | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) | ||
|
||
### Advanced Configuration | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) | ||
|
||
### Deployment | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
||
### `npm run build` fails to minify | ||
|
||
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
Oops, something went wrong.