Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New features #15

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
server/.env
server/node_modules
.vscode
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ A crossword consists of clues, answers, and a layout:

This crossword layout generator takes in a list of answers and outputs a crossword layout. Our program **does not** generate the answers or the clues.

## Running the code locally

**Step 1:** Navigate to the server directory: `cd server`

**Step 2:** Install project dependencies: `npm install`

**Step 3:** Create a file named `.env` in `server`. In the file, add your API key: `OPENAI_API_KEY=your_api_key`

**Step 4:** Start the server with `npm start` (default: port 3000)

**Step 5:** Go back to the main project directory and run the live server extension.

## Input and Output Format

An input is a list of answers in a JSON format. The clues can optionally be included with the input.
Expand Down
Loading