Skip to content

SimonEOA/Smash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

# SMASH

SMASH is a monorepo project with the following components:

- **Frontend**: React.js (Next.js)
- **Backend**: Python (FastAPI)
- **Models**: Named Entity Recognition (NER) pre trained model (Flair)
- **Language Model**: OpenAI GPT-3.5 turbo api
- **Database**: PostgreSQL
- **Deployment**: in progress

## Installation Instructions (Local Development)

1. Clone the repository:

   ```
   git clone https://github.com/SimonEOA/Smash.git
   ```

2. Set up venv:

   ```
   python -m venv .venv
   source .venv/bin/activate
   ```

3. Install frontend dependencies:

   ```
   cd frontend/app
   npm install
   ```

4. Install backend dependencies:

   ```
   cd backend
   pip install -r requirements.txt
   ```

5. add .env.local file in frontend/app and insert:
   NEXT_PUBLIC_API_URL=<SERVER_URL>

6. add .env.local file in backend and insert:
   JWT_SECRET_KEY=<YOUR_SECRET>
   SQLALCHEMY_DATABASE_URL=<YOUR_DATABASE_URL>
   OPENAI_API_KEY=<YOUR_OPENAI_API_KEY>

7. Start the frontend development server:

   ```
   npm run dev
   ```

8. Start the backend server:

   ```
   uvicorn main:app --reload
   ```

Now you can access the application by opening your browser and navigating to http://localhost:3000.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published