README.md

Coral Companion

Coral Island companion web app

Live site »

Table of Contents

• Table of Contents
• Features
• Documentation
• Run Locally
• Resources
• Tech Stack
• License

Features

• Account creation and login
• Different profiles for each account
• Character and item seasonal overview
• Todo list
• Dark mode

Documentation

API-Documentation

Run Locally

Make sure Docker is installed and running

Clone the project

  git clone https://github.com/salem404/coral-companion

Install dependencies in the project directory

  npm install && composer install

Create environment file

  cp .env.example .env

Start the server in the project directory

  vendor/bin/sail up

Create laravel application key

  vendor/bin/sail artisan key:generate

Create the database and seed it with data

  vendor/bin/sail artisan migrate --seed

Resources

Resource	Name	Author	Source	License
Application logo	logo.svg	Paula Rumeu	Own creation
Application logo	logo-color.svg	Paula Rumeu	Own creation
Background waves	wave1.svg	Paula Rumeu	Own creation
Background waves	wave2.svg	Paula Rumeu	Own creation
Background foam	foam.svg	Paula Rumeu	Own creation
Background foam	foam2.svg	Paula Rumeu	Own creation
Gnome	gnome.svg	Paula Rumeu	Own creation
Gnome	gnome0.svg	Paula Rumeu	Own creation
Gnome	gnome1.svg	Paula Rumeu	Own creation
Gnome	gnome2.svg	Paula Rumeu	Own creation
Character and Item icons		Stairway Games	Coral Island Wiki
Sign Out Icon	si_Sign_out.svg	Abhimanyu Rana	SargamIcons
Sun Icon	si_Sun.svg	Abhimanyu Rana	SargamIcons
Swap Icon	si_Swap_horiz	Abhimanyu Rana	SargamIcons
Moon Icon	moon.svg	Abhimanyu Rana	SargamIcons
Alert Icon		Abhimanyu Rana	SargamIcons
Check Icon		Abhimanyu Rana	SargamIcons
Trash icon		Mikhail Kolomietc	Figma
Edit icon		Mikhail Kolomietc	Figma
OpenEye icon		Mikhail Kolomietc	Figma
ClosedEye icon		Mikhail Kolomietc	Figma
GitHub Icon	GitHubIcon.svg	Github	GitHub

Tech Stack

Version Control:

Design:

Deployment:

Client:

Server:

Testing:

Linting:

Documentation:

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.