Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aarsxx/datamine
Take home project @datamine
https://github.com/aarsxx/datamine
heroku-cli laravel pgsql tailwind trello
Last synced: 3 months ago
JSON representation
Take home project @datamine
- Host: GitHub
- URL: https://github.com/aarsxx/datamine
- Owner: aarsxx
- License: mit
- Created: 2024-05-31T12:18:19.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-05T16:52:39.000Z (8 months ago)
- Last Synced: 2024-09-28T18:07:45.083Z (4 months ago)
- Topics: heroku-cli, laravel, pgsql, tailwind, trello
- Language: JavaScript
- Homepage: https://datamine-13120b40742a.herokuapp.com/
- Size: 24 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
This is a web-based to do list application developed using Laravel, Livewire, and Tailwind CSS. The application allows users to create, manage, and organize their tasks into groups. It offers features such as task grouping, scheduling, and user authentication.
## Main Features
- User Authentication: Secure system for user login and data protection.
- Task Creation: Create tasks with name, description, due date, and priority.
- Task Groups: Organize tasks into categories (e.g., work, personal).
- Scheduled Tasks: Set tasks to repeat daily, weekly, or monthly.
- Task List: View and manage tasks in a list format.
- Task Status: Mark tasks as completed or pending.
- Responsive UI: Works on various devices and screen sizes.
## 🚨 Forking this repo (please read!)
I value keeping my site open source, but as you all know, _**plagiarism is bad**_. It's always disheartening whenever I find that someone has copied my site without giving me credit. I spent a non-trivial amount of effort building and designing this iteration of my website, and I am proud of it! All I ask of you all is to not claim this effort as your own.
## Flow Chart
## Prerequisites
Before you start, please install this:
- [PHP](https://www.php.net/) (>=8.3)
- [Laravel](https://laravel.com/) (>=8.8)
- [Composer](https://getcomposer.org/) (>=2.7.5)
- [Node.js](https://nodejs.org/) (>=16.0.0)
- [NPM](https://www.npmjs.com/)
- [Tailwind](https://tailwindcss.com/) (3.3.0)
- [PostgresSQL](https://www.postgresql.org/)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/andikaleonardo/datamine
```
2. Navigate to the project directory:
```bash
cd datamine
```
3. Update PHP dependencies using Composer:
```bash
composer update
```
4. Install PHP dependencies using Composer:
```bash
composer install
```
4. Install JavaScript dependencies using NPM:
```bash
npm install
```
5. Create a `.env` file by copying `.env.example` and update it with your database configuration:
```bash
cp .env.example .env
```
6. Generate application key:
```bash
php artisan key:generate
```
7. Make sure `APP_URL` & `ASSET_URL` in `.env` is defined because laravel pointed to those URL.
```bash
APP_URL=https://datamine-13120b40742a.herokuapp.com
ASSET_URL=https://datamine-13120b40742a.herokuapp.com
```
8. Migrate the database:
```bash
php artisan migrate
```
9. Compile Assets:
```bash
npm run dev
```
10. Start the Local development server:
```bash
php artisan serve
```
11. Access the Application: Open your web browser and go to `http://localhost:8000`
## Deploying to Heroku
1. Log in to Heroku:
```bash
heroku login
```
2. Create a new Heroku application:
```bash
heroku create your-app-name
```
3. Add the Heroku Postgres add-on:
```bash
heroku addons:create heroku-postgresql:hobby-dev
```
4. Set environment variables in Heroku:
```bash
heroku config:set APP_KEY=$(php artisan key:generate --show)
heroku config:set APP_ENV=production
heroku config:set APP_DEBUG=false
heroku config:set APP_URL=https://your-app-name.herokuapp.com
heroku config:set ASSET_URL=https://your-app-name.herokuapp.com
```
5. Add a Procfile to the root of your project to instruct Heroku how to run your app. Create a Procfile file with the following content:
```Procfile
web: vendor/bin/heroku-php-apache2 public/
```
6. Commit your changes to git:
```bash
git add .
git commit -m "Prepare for Heroku deployment"
```
7. Deploy your application to Heroku:
```bash
git push heroku main
```
8. Run database migrations on Heroku:
```bash
heroku run php artisan migrate
```
9. Access your application on Heroku:
Open your web browser and go to https://your-app-name.herokuapp.com