Description

We want slack and asana in one. For us it is kinda a hassle to switch between asana and slack at the same time. It would also be best that Developer Leads/Team leads can create a team with their members and members can also make their task list/todo list so that their team leads can view what his/her members are doing.

🔗 Links

Client :: https://slackana-client.vercel.app/sign-in
Server :: https://slackana-api.herokuapp.com/

Developers

Quality Assurance

Installation

Clone my-project with github

  $ git clone https://github.com/abduljalilpalala/ps-slackana.git

  or

  $ git clone git@github.com:abduljalilpalala/ps-slackana.git

Environment Variables

To run this project locally, you will need to add the following environment variables to .env file in the back-end folder. If .env file does not exist just create a new one and add this ff:

APP_NAME=Laravel
APP_ENV=local
APP_KEY= // Generate a new key
APP_DEBUG=true
APP_URL=http://localhost:8000
FRONTEND_URL=http://localhost:3000

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=slackana
DB_USERNAME=root
DB_PASSWORD=

Make sure to create a Database based on the DB_DATABASE value.

Run Locally

After cloning the project

Go to the project directory

  $ cd ps-slackana

Commands for running the Front End

From the Root folder install dependencies for the Front End

  $ cd client
  $ npm install

  or

  $ cd client
  $ yarn

Start the Front End Server

  $ npm run start

  or

  $ yarn dev

Commands for running the Back End

From the Root folder install dependencies for the Back End

  $ cd api
  $ composer install
  $ php artisan migrate:fresh --seed

Optimize the back end (optional if you encounter a route error)

  $ php artisan config:clear
  $ php artisan cache:clear
  $ php artisan route:clear
  $ php artisan optimize
  $ composer dump-autoload

Start the Back End Server

  $ php artisan serve

  or

  $ php artisan serve --host=localhost

Commands for running the Docker

Prerequisite: Docker Desktop

After installing Docker Desktop, navigate to the root of the project repo
Setup .env (refer on .env.example) on the root of the repo
Start the Docker containers to build the app initially. Use the command below if there are changes to the code, for example: new merged PRs

  $ docker-compose up --build

You must also seed the database on the API container after you have initially started the all docker containers to create initial data for the app.
- On the docker desktop app, locate the API container, for example: ps-slackana_api_1
- Open the terminal by clicking the terminal icon on the right side of the container next to the pause icon
- Run the command below:

  $ php artisan db:seed

Additional: If there are no changes to the code and you have already built the app before, you can run the command below to avoid rebuilding and just start the containers directly

  $ docker-compose up

License

Tech Stack

Client: Next.js, Redux Toolkit, Redux Thunk, TailwindCSS

Server: Laravel, MySQL

Feedback

If you have any feedback, please reach out to us, link provided above.

For support, email support@slackana.com or join our Slack channel.

Appendix

Any additional information goes here

jsvelte/ps-slackana