nikhilnathr/taskord

✅ Get things done socially (Alpha)

Taskord

✅ The Taskord Web App

taskord.com »

Report Bug • Request Feature

About Taskord

• ✅ Tasks: All tasks are public and added to your maker profile.
• 🔥 Reputation: Earn reputations by completing, praising and commenting on tasks and questions, which helps you to stay productive.
• 😀 Makers: Community of peoples who ships constantly.
• 📦 Products: Ship your products to Taskord and make regular updates about the product and even add tasks to them.
• 💬 Q&A: Get your questions answered and use this feature as dicussion too.
• 🎁 Deals: Discounts and special deals for Taskord members. Only available to patrons.

Prerequisites

• PHP: please refer to their installation guide.
• Node: we recommend using nvm to install the Node version listed on the badge.
• MySQL 8.0 or higher.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project, ie. https://github.com/taskord/taskord/-/forks/new
2. Clone your forked repository, ie. git clone https://github.com/<your-username>/taskord.git
3. Create your Feature Branch (git checkout -b AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature)
5. Push to the Branch (git push origin AmazingFeature)
6. Open a Pull Request

Standard Installation

1. Make sure all the prerequisites are installed.
2. Set up your environment variables/secrets in .env file

   cp .env.example .env

3. Run the below commands to install taskord

   # Install Composer Dependencies
   composer install
   
   # Install NPM Dependencies
   npm install
   
   # Build assets for development
   npm run dev
   # Build and minify assets for production
   npm run production
   # Build for dev (With sourcemaps) and watch for changes
   npm run dev
   
   php artisan key:generate
   php artisan migrate:fresh --seed

4. That's it! Run php artisan serve to start the application and head to http://localhost:8000

Development using Docker

This repository ships with a Docker Compose configuration intended for development purposes. It'll build a PHP image with all needed extensions installed and start up a MySQL server and a Node image watching the UI assets.

To get started, make sure you meet the following requirements:

• Docker and Docker Compose are installed
• Your user is part of the docker group

If all the conditions are met, you can proceed with the following steps:

1. Make sure port 8080 is unused or else change DEV_PORT to a free port on your host.
2. Run chgrp -R docker storage. The development container will chown the storage directory to the www-data user inside the container so Taskord can write to it. You need to change the group to your host's docker group here to not lose access to the storage directory.
3. Run docker-compose up and wait until all database migrations have been done.
4. You can now login with test and test as password on localhost:8080 (or another port if specified).

If needed, You'll be able to run any artisan commands via docker-compose like so:

docker-compose run app php artisan list 

---

Happy Shipping 🚀