Skip to content

Commit

Permalink
adding .bat and .sh files to setup and start project easily
Browse files Browse the repository at this point in the history
  • Loading branch information
Eng-Elias committed Mar 24, 2024
1 parent a2fcd07 commit f7af9ac
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 4 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ This application provides a simplified user interface for leveraging the power o

To get started with the CrewAI Simplified App, install [PostgreSQL](https://www.postgresql.org/download/), setup PostgreSQL user and password and follow these simple steps:

For non-developers:

1. **Setup the project**: clone or download the project then run `setup_win.bat` for Windows users or `setup_linux_mac.sh` for Linux or MacOS users.

2. **Start the project**: run `start_win.bat` for Windows users or `start_linux_mac.sh` for Linux or MacOS users. ✔Finish!

For developers:

1. **Installation**: Clone the repository and install dependencies using npm or yarn:

```bash
Expand Down Expand Up @@ -128,6 +136,7 @@ This app is built using TypeScript, Prisma, GraphQL, Next.js, and node-calls-pyt
- Improvement:
- Update python and npm packages.
- Some UI enhancements.
- Add .bat and .sh files to setup and start the project easily for normal users.
- Enhance README.md.
## To Do
Expand Down
11 changes: 7 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ alembic==1.13.1
annotated-types==0.6.0
anyio==4.3.0
appdirs==1.4.4
arxiv==2.1.0
asgiref==3.7.2
attrs==23.2.0
backoff==2.2.1
Expand Down Expand Up @@ -34,6 +35,7 @@ docstring-parser==0.15
duckduckgo_search==4.4.3
embedchain==0.1.97
fastapi==0.110.0
feedparser==6.0.10
filelock==3.13.1
flatbuffers==24.3.7
frozendict==2.4.0
Expand All @@ -50,7 +52,7 @@ google-cloud-core==2.4.1
google-cloud-resource-manager==1.12.3
google-cloud-storage==2.15.0
google-crc32c==1.5.0
google-generativeai==0.3.2
google-generativeai==0.4.1
google-resumable-media==2.7.0
googleapis-common-protos==1.62.0
gptcache==0.1.43
Expand All @@ -77,11 +79,11 @@ lancedb==0.5.7
langchain==0.1.13
langchain-community==0.0.29
langchain-core==0.1.33
langchain-experimental==0.0.52
langchain-google-genai==0.0.9
langchain-experimental==0.0.55
langchain-google-genai==0.0.11
langchain-openai==0.0.5
langchain-text-splitters==0.0.1
langsmith==0.1.27
langsmith==0.1.31
lxml==5.1.0
Mako==1.3.2
markdown-it-py==3.0.0
Expand Down Expand Up @@ -161,6 +163,7 @@ schema==0.7.5
selenium==4.18.1
semanticscholar==0.7.0
semver==3.0.2
sgmllib3k==1.0.0
shapely==2.0.3
six==1.16.0
smmap==5.0.1
Expand Down
26 changes: 26 additions & 0 deletions setup_linux_mac.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/bin/bash

# Install npm packages
echo "Installing npm packages..."
npm i

# Create Python virtual environment
echo "Creating Python virtual environment..."
python3 -m venv venv

# Install Python packages using pip
echo "Installing Python dependencies..."
./venv/bin/python ./venv/bin/pip install -r requirements.txt

# Prisma Migrations
echo "Applying Prisma Migrations..."
npx prisma generate
npx prisma migrate deploy

# Building the project
echo "Building the project..."
npm run build

# Building is finished
echo "Building is finished"
pause
25 changes: 25 additions & 0 deletions setup_win.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
@echo off

REM Install npm packages
echo Installing npm packages...
call npm i

echo Creating Python virtual environment...
call python -m venv venv

REM Install Python packages using pip
echo Installing Python dependencies...
call "./venv/scripts/python.exe" "./venv/scripts/pip.exe" install -r requirements.txt

REM Prisma Migrations
echo Applying Prisma Migrations...
call npx prisma generate
call npx prisma migrate deploy

REM Building the project
echo Building the project
call npm run build

REM Building is finished
echo Building is finished
pause
9 changes: 9 additions & 0 deletions start_linux_mac.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

# Open browser
echo "Opening browser..."
open http://localhost:3000

# Run the project
echo "Starting development server..."
npm start
10 changes: 10 additions & 0 deletions start_win.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
REM Run the project
echo Starting development server...
start call npm start

REM Wait for a few seconds to ensure the server is up and running
timeout /t 2

REM Open browser
echo Opening browser...
start http://localhost:3000

0 comments on commit f7af9ac

Please sign in to comment.