Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 4.6 KB

README.md

File metadata and controls

79 lines (59 loc) · 4.6 KB
Raw

ACMAS-Frontend

Lint Code Base Codacy Badge Django CI

ko-fi

Usage

Note: Docker is a pre-requisite installation to run ACMAS in a development environment. It is highly recommended to use Docker Desktop instead of Docker CLI. If you do not have Docker installed, please do so before continuing to the remainder of the instructions.

Setup

Using the Docker containers

Each time you make changes to the code you will need to turn off the Docker container and then turn it back on. Make sure to turn off the container when you are done working. Some changes to the database structure may require manual deletion of docker "volumes" associated with ACMAS.

Start Docker

In order to run Docker applications you must open Docker Desktop or start the Docker service on your device.

Navigate to /ACMAS-Frontend/ACMAS

Open the repository directory ACMAS-Frontend and navigate to the ACMAS directory within. Open this ACMAS directory in the command-line or terminal.

Turn on the Docker containers when you want to start working

docker-compose up -d --build

Turn off the Docker containers when you are done working

If you want to shut down normally: docker-compose down

If you want to flush your database and project files: docker-compose down -v

Using ACMAS with Docker

After turning on the Docker container follow these steps:

Ensure that the Docker application was successfully built and is running

  • Successful builds will return no errors (red)

  • One of the following messages will appear in your command prompt

    • Note: If you do not flush, only the affected containers will appear
    Running 3/3
- Container acmas-db-1      Started
- Container acmas-web-1     Started
- Container acmas-nginx-1   Started

  • Ensure that the application's containers in Docker Desktop all appear as green

  • Navigate to localhost in any web browser

    • If this does not work, default to using 127.0.0.1

Resolving issues with Docker and/or ACMAS

  1. Check for an error message. If one appears, search it on Google or talk to other ACMAS developers on your sub-team
    • Error messages will appear inside Docker containers. Access these by clicking on the container name in Docker Desktop or by running docker ps to get container IDs and then docker logs <container ID>.
  2. If you are unable to find the exact error code on Google, attempt to search for similar or more generic versions
  3. Discuss the issue with other ACMAS sub-teams
  4. Talk to the project lead Jacob @jaw12346
  5. Open an issue!

Executive Summary

ACMAS, or Automatic Course Material Archiving System is a free-to-use database site for anyone to both upload and view documents, materials, coursework, etc. for various courses and questions from any school/institute. On the internet today, there are many services that allow students to help each other with homework from various courses all over the world. However, those services are not free to access, which can make it difficult for everyone to use. ACMAS is a free-to-use database available for anyone to upload, and view backtests from their specific college’s courses, which can be very helpful for test preparation.

Features

There are many features that ACMAS will contain to make accessing content and using the database as simple and straightforward as possible. First, ACMAS will be able to support uploading problems as photos/PDFs/scanned-in documents. In addition to this, there will also be the ability to search for problems by a specific school and course, by a specific question, or by image, which would all allow the user to find the backtests and backwork that they are looking for and use them for their own studying. There also will be links from questions on backtests to alternative answers to the same question from other sources.