Skip to content

Sergix/workdrop

Repository files navigation

workdrop

Netlify Status.

A file request app for educators

Created for #twiliohackathon

Workdrop enables you to request any type of assignment from your students.

Simply enter the assignment name, your students' emails, and your email. No account creation required.

Requirements

  • yarn
  • MongoDB Stitch instance
  • Twilio SendGrid account

Deploying to Stitch

Instructions are here in the MongoDB docs on how to deploy this project's stitch directory to a MongoDB Stitch instance.

Next, create a MongoDB Atlas cluster named cluster0 with collections request and submissions. If you wish to edit the cluster name, edit stitch/services/atlas-cluster0/config.json

Then, you need to add your API keys using Secrets in the Stitch UI.

The required API keys are:

  • SENDGRID_API_KEY
  • S3_ACCESS_KEY

The S3 public key can be set in stitch/services/s3-submissions/config.json.

The S3 bucket should be named workdrop-submissions in AWS, but you can change this by editing the rules in stitch/services/s3-submissions/rules.

Build Setup

Clone the repository

git clone https://github.com/sergix/workdrop

Install dependencies (yarn preferred)

yarn install

Then run the project locally:

yarn serve

Optional configuration

Development Server

Create a .env file in the root directory containing your development server host and port (defaults to localhost on port 3000)

.env

DEV_HOST=localhost
DEV_PORT=3000

Local development server

yarn serve

About

File requesting made simple.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published