FishMust.Live is a social awareness website where users can visualize areas affected by plastic pollution on a map, share their own observations of plastic pollution with location information, and view plastic pollution shared by other users.
- PHP
- Laravel
- AWS
- CSS
- Bootstrap
- JavaScript
- Mapbox API
- MySQL
To set up the project locally, follow the steps below:
-
Clone the repository:
$ git clone https://github.com/syaycili/fishmustlive.git $ cd fishmustlive
-
Install dependencies:
$ composer install $ npm install
-
Configure the environment variables:
- Create a copy of the
.env.example
file and name it.env
. - Update the necessary environment variables such as database credentials, AWS configuration, and Mapbox API key in the
.env
file.
- Create a copy of the
-
Generate an application key:
$ php artisan key:generate
-
Set up the database:
- Create a MySQL database for the project.
- Update the
DB_DATABASE
,DB_USERNAME
, andDB_PASSWORD
variables in the.env
file with your database details.
$ php artisan migrate
-
Compile assets:
$ npm run dev
-
Start the local development server:
$ php artisan serve
The website should now be accessible at
http://localhost:8000
.
Provide instructions on how to use the website. Include any important features or functionalities.
- Users can sign up or log in to the website.
- Once logged in, they can view the map showing areas affected by plastic pollution.
- Users can click on the map to share their observations of plastic pollution, including location information.
- Users can view plastic pollution shared by other users on the map.
- Additional features and functionalities...
If you want to contribute to this project, follow the steps below:
- Fork this repository.
- Create a new branch:
git checkout -b my-feature
. - Make your changes and commit them:
git commit -m 'Add my feature'
. - Push to the branch:
git push origin my-feature
. - Submit a pull request.
Please make sure to update tests as appropriate and provide a detailed explanation of your changes.
Specify the license under which your project is distributed. For example:
This project is licensed under the MIT License.