The web platform that uses an instance of an artificial intelligence model for the detection of early-stage brain tumors using magnetic resonance imaging (MRI) and convolutional neural networks (CNN). The application will allow users to upload MRI images of patients and, through the model, analyze them to detect possible early-stage brain tumors. This repository is contains the front end client to use the BTF model.
https://btf-image-analyzer-api-production.up.railway.app/docs
First need to install npm requeriments
npm i
then to run locally the project we need to run dev env
npm run dev
V 13.3.0 is used in this project
As an open-source project, we welcome and encourage contributions to BrainTumorFinder. If you wish to contribute, there are several ways to do so.
If you come across an error or an issue, please create a new issue on the project's GitHub page. Ensure you describe the problem you have encountered in as much detail as possible, including steps to reproduce it, any error messages received, and the version of the code you are using.
If you wish to contribute improvements to the code, please submit a pull request. Ensure you explain in detail what changes you have made and why you believe these are beneficial to the project. Also, make sure that your code adheres to the project's coding and style conventions.
Remember, your contribution can make a significant difference and helps to improve the detection and treatment of brain tumors. Thank you for your collaboration!
As an open-source project, we appreciate and encourage contributions to BrainTumorFinder. The project workflow is based on Development (Dev), Quality Assurance (QA), and Production (Main) branches for the Frontend, Backend, and Machine Learning (ML) model. Here's a list of numbered steps on how you can contribute to the project:
-
Understand the project: Before you can effectively contribute, it's crucial to understand how the project works, what it does, and how its code is organized.
-
Identify an issue or improvement: Once you thoroughly understand the project, you can start looking for ways to improve it.
-
Create an issue: If you've found a problem or have an idea for an improvement, the first step is to create an issue on GitHub.
-
Fork the repository: To make changes to the code, you need your own copy of the GitHub repository. Fork the repository to create a copy in your GitHub account.
-
Clone the repository: Once you have your own fork, you can clone the repository to your local machine.
-
Create your working branch: Based on the development branch corresponding to your task (Frontend, Backend, ML), you should create a new branch following the nomenclature:
feature/ml-number: for new features or improvements in the project.bugfix/bug-number: to fix errors in the project.hotfix/bug-number:
to address critical issues that arise in production and require a quick solution.
- release/version: to prepare new project versions that will go into production.
-
Make your changes: Make the changes you deem appropriate in your local copy of the code.
-
Commit and push your changes: When you're satisfied with your changes, commit them to your repository and then push to your fork on GitHub.
-
Submit a pull request (PR): With your changes already on GitHub, you can submit a pull request to the original repository. Ensure you explain in detail what changes you've made and why.
-
Respond to any feedback: If you receive feedback on your PR, make sure to respond and make any changes that are requested.
-
Celebrate your contribution: Once your PR has been accepted, you've made an official contribution to the project! Keep your fork updated with changes in the original repository to continue contributing in the future.
Remember, your contribution can make a significant difference and help to improve the detection and treatment of brain tumors. Thank you for your collaboration!
This project run under MIT Licence
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent