cosmic-sizing-tool

OVERVIEW

User stories

Dasboard

Consult the dashboard

README

This README documents the steps necessary to get your application up and running.

What is this repository for?

• Quick summary
• Version
• Learn Markdown

How do I get set up?

Summary of set up####

The Play framework is needed in order to run this program.

Configuration

Write config info here.

Dependencies

• Play Framework

1. Download it.
2. Make a new folder and extract the .zip file in it.
3. Add activator to your PATH or create the following link substituting /path/to/activator with the absolute path to the activator executable by executing sudo ln -s /path/to/activator /usr/local/bin/activator. Consult this link for the complete installation documentation.

• SQLite 3

1. Download and install SQLite 3 for your platform at https://www.sqlite.org/.

Database configuration

Manual configuration is not needed. An sql script will be executed to create the missing tables when the server is run.

You may get the message Database 'default' is in an inconsistent state!. This is because Sqlite3 doesn't seem to work with foreign keys. Just click on Mark it resolved.

How to run tests

Write content here.

Deployment instructions

To build and run the application in the Play server, execute make server. It may take some time to download some missing packages the first time if you have installed activator-minimal.

Once the server is running you can connect to the application's webpage by entering http://127.0.0.1:9000 in your browser's address bar. The first time you access the application, it may take a while because of the compilation process.

Use Ctrl + D to stop the server and go back to the console.

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
• Other community or team contact