About The Project

[Add small gif to show some feature]

Wirecracker provides a intuitive solution for designing, executing, and managing localization and stimulation plans. Key Development Goals:

• Replace traditional CSV-based interfaces with a modern, user-friendly GUI for improved usability and efficiency.
• Facilitate smooth communication and data sharing between teams to enhance productivity and reduce errors.
• Build a centralized, well-organized database to store plans, enabling quick retrieval and analysis.

(back to top)

Usage

Usage of the website can be found in the documentation page

(back to top)

Self Hosting

This section provides a guide for self-hosting. For development, please refer to code documentation and readme in each folder.

Prerequisites

Followings are required to host your own Wirecracker

• node.js
• npm
• supabase setup
• Google OAuth 2 token

Database ERD

You are required to have database with following tables in supabase. Data we used for core functionality can be located in ./data foulder

Core functionality:

File share and cloud saving

Installation

1. Clone the repo

   git clone https://github.com/UCD-193AB-ws24/Wirecracker.git
   

2. Go into project folder

   cd Wirecracker
   

3. Configure hosting environment variables in .env

   ./.env

   VITE_SUPABASE_URL=[your url to supabase]
   VITE_SUPABASE_ANON_KEY=[your token for supabase]
   

   ./backend/.env

   RESEND_API_KEY=[your ... for ...]
   SUPABASE_URL=[your url to supabase. Same as VITE_SUPABASE_URL]
   SUPABASE_KEY=[your token for supabase. Same as VITE_SUPABASE_ANON_KEY]
   GOOGLE_CLIENT_ID=[your id for google auth]
   GOOGLE_CLIENT_SECRET=[your token for google auth]
   SESSION_SECRET=[your ... for ...]
   

4. Configure hosting information in config.json

   ./config.json

   {
       "port": [back-end port],
       "frontendURL": "[your front-end url]",
       "backendURL": "[your back-end url]"
   }
   

5. Start it

   1. Install npm packages on frontend

      npm install
      

   2. Run frontend

      npm run dev
      

   3. On separate console, install npm packages on backend

      cd backend; npm install
      

   4. Run backend

      npm run dev
      

(back to top)

Contributing Guidelines

Read our contributing guidelines to learn about our submission process, coding rules, and more.

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Support: contact@wirecracker.com

Project Link: https://github.com/UCD-193AB-ws24/Wirecracker

(back to top)

Acknowledgments

• Tools for NIfTI and ANALYZE image by Jimmy Shen

(back to top)