|
a |
|
b/docs/Local_Analyzer_Setup.md |
|
|
1 |
# Local DNA Analyzer Setup Guide |
|
|
2 |
|
|
|
3 |
This guide explains how to set up and run the local DNA Analyzer with web interface integration. |
|
|
4 |
|
|
|
5 |
## Prerequisites |
|
|
6 |
|
|
|
7 |
- Java 17 or higher |
|
|
8 |
- Gradle build tool |
|
|
9 |
- Modern web browser |
|
|
10 |
- DNA Analyzer application downloaded and built |
|
|
11 |
|
|
|
12 |
## Setup Steps |
|
|
13 |
|
|
|
14 |
1. **Build the Application** |
|
|
15 |
```bash |
|
|
16 |
./gradlew build |
|
|
17 |
``` |
|
|
18 |
|
|
|
19 |
2. **Start the Local Server** |
|
|
20 |
```bash |
|
|
21 |
./gradlew bootRun |
|
|
22 |
``` |
|
|
23 |
This will start the Spring Boot application on port 8080. |
|
|
24 |
|
|
|
25 |
3. **Access the Web Interface** |
|
|
26 |
- Open your web browser and navigate to the DNAnalyzer website |
|
|
27 |
- Scroll down to the "Local Analyzer" section |
|
|
28 |
- You'll see a form with: |
|
|
29 |
- File path input field |
|
|
30 |
- Checkboxes for analysis features: |
|
|
31 |
- Verbose Mode (-v) |
|
|
32 |
- Detailed Report (-d) |
|
|
33 |
- Quick Analysis (-q) |
|
|
34 |
|
|
|
35 |
## Using the Local Analyzer |
|
|
36 |
|
|
|
37 |
1. **Enter File Path** |
|
|
38 |
- Provide the full path to your DNA file |
|
|
39 |
- Example: `/path/to/your/dna/sequence.fa` |
|
|
40 |
|
|
|
41 |
2. **Select Features** |
|
|
42 |
- Check the boxes for desired analysis features |
|
|
43 |
- Each feature maps to a command-line argument: |
|
|
44 |
- Verbose Mode → -v |
|
|
45 |
- Detailed Report → -d |
|
|
46 |
- Quick Analysis → -q |
|
|
47 |
|
|
|
48 |
3. **Run Analysis** |
|
|
49 |
- Click the "Run Analysis" button |
|
|
50 |
- The analysis will be performed locally using your installed DNA Analyzer |
|
|
51 |
- Results will be displayed on the webpage |
|
|
52 |
|
|
|
53 |
## Troubleshooting |
|
|
54 |
|
|
|
55 |
If you encounter issues: |
|
|
56 |
|
|
|
57 |
1. **Server Connection** |
|
|
58 |
- Ensure the local server is running on port 8080 |
|
|
59 |
- Check if you see any error messages in the terminal |
|
|
60 |
|
|
|
61 |
2. **File Access** |
|
|
62 |
- Verify the file path is correct and accessible |
|
|
63 |
- Ensure proper read permissions for the file |
|
|
64 |
|
|
|
65 |
3. **Analysis Errors** |
|
|
66 |
- Check the server logs for detailed error messages |
|
|
67 |
- Verify that the DNA Analyzer is properly installed |
|
|
68 |
|
|
|
69 |
## Technical Details |
|
|
70 |
|
|
|
71 |
- The web interface communicates with a local REST API |
|
|
72 |
- API endpoint: `http://localhost:8080/api/analyze` |
|
|
73 |
- CORS is enabled to allow web access to local server |
|
|
74 |
- The server translates web interface selections into command-line arguments |
|
|
75 |
|
|
|
76 |
For additional help or bug reports, please visit our [GitHub repository](https://github.com/VerisimilitudeX/DNAnalyzer) or join our [Discord server](https://discord.gg/xNpujz49gj). |