fossabot/algorepo

Actual project for dissertation.

algo-repo

A website hosting a repository of algorithms which users can use and publish

Getting Started

This project uses Vue.JS and Nuxt.JS for the frontend, and Express.JS for the backend. The database used is MongoDB.

Development

You need Node.JS installed as a prerequisite.

Also, you need a MongoDB instance available. You can either roll your own, or use the docker-compose.yml file provided to run one with Docker. If you don't use the docker compose file, make sure to set the MONGODB_URI environment variable.

1. yarn to install dependencies
2. yarn run db:seed. This will seed the database. The step is optional and will provide you with a basic user and a basic calculator.
3. yarn run dev will start the development server with hot reloading - no restarts neccesary (unless you add new dependencies)!

Off you go!

Production

You need Docker installed as a prerequisite.

A Docker image for the web service is publish under dannycjones/dis_web.

You can adapt the docker-compose.yml file for production. Change the web service port if you need to. Here is an example of a docker compose file serving directly onto port 80.

version: '3'

services:
  web:
    image: dannycjones/dis_web
    ports:
      - "80:3000"
    environment:
      - MONGODB_URI=mongodb://mongo/main
    depends_on:
      - mongo
  mongo:
    image: mongo:3.6
    ports:
      - "27017:27017"
    volumes:
      - mongo_data:/data/db

volumes:
  mongo_data:

License