README.md

Oxeye - Sapper Universal/Isomorphic Web Application Skeleton Project Implementing Authentication

Dependencies

• MongoDB
• Express
• Mongoose

Set local development environment

• install direnv, Docker and docker-compose
• change working directory to the project root
• create file .envrc with the following contents:

export MONGO_INITDB_ROOT_USERNAME=admin
export MONGO_INITDB_ROOT_PASSWORD=password
export ME_CONFIG_MONGODB_ADMINUSERNAME=admin
export ME_CONFIG_MONGODB_ADMINPASSWORD=password
export MONGO_URI='mongodb://admin:password@mongo/oxeye?authSource=admin&retryWrites=true&w=majority'
export JWT_SECRET_KEY=your-super-secret-key
export MAILGUN_API_KEY=some-mailgun.key
export MAILGUN_DOMAIN=your-mailgun-domain

• run direnv allow .
• run docker-compose up --build

Your Oxeye application should be available at http://localhost:3000/ and if you need to check Mongo database by Mongo Express administration tool, it should be available at http://localhost:3001/.

If there is no user in the database, Oxeye is going to create admin user and you can see the password in the output.

TODO

• implement authorization
• implement accounting

Demo

---

Sapper documentation