Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 1.81 KB
Raw

Hello there!

So, you want to help improve the site — great!

Local setup is fairly straightforward:

  1. Run the server (you'll need Rust): 
    $ cd server && cargo run
  2. Install the client components (you'll need npm): 
    $ cd client && npm install
  3. Run the client: 
    $ cd client && npm run dev
  4. Open http://localhost:5173/.

If you modify the files under client/, the browser view should auto-update. If you modify files under server/, you'll have to re-run cargo run to see its effects.

Note that when run this way, to aid in development, the server will auto-populate an event with a set of questions from a past live Q&A session I ran at http://localhost:5173/#/event/00000000-0000-0000-0000-000000000000/secret. It will also auto-generate user votes over time for the questions there.

If you're curious about the technologies used in the server and client, see their respective README.md files.

To run tests against a DynamoDB instance running locally, make sure you got docker and AWS CLI installed, then hit:

$ cd server
$ ./run-dynamodb-local.sh

This will also spin a Web UI for your local DynamoDB instance.

You can now run tests with:

USE_DYNAMODB=local cargo t -- --include-ignored

Assuming you are staying in the server directory, to run the back-end application against your local DynamoDB instance, hit:

USE_DYNAMODB=local cargo run