Giter Club home page Giter Club logo

task-management-app's Introduction

Getting Started with the task management app

How to run the API server

  • Create an instance of a PostgreSQL database. If you have Docker installed, you could spin up an ephemeral instance of a Postgres container like so:

    docker run --name postgresql -e POSTGRESQL_USER=guild -e POSTGRESQL_PASSWORD=guild -e POSTGRESQL_DATABASE=guild bitnami/postgresql:latest
    
  • Navigate to src/server and perform an npm install

  • Start the API server using npm run start. This will create the table structure using Sequelize, if the db schema doesn't exist yet.

How to run the React app

  • Navigate to the src/client directory and perform an npm install.
  • Start the React app using npm run start. This should pop open a development version of the app in your browser under http://localhost:3002/
  • From here, you should be able to create your first task. It should return you to the list of tasks (with your single one there). You add more, then click the column headers to sort the results. You can also type in a search term to filter the list down, or remove the term to return to the original results.
guild-tasks-example.mp4

Caveats

There are some obvious things that are missing, such as

  • No user auth. On the API side, there's an easy way to add an auth middleware in api.service.js in the routes.
  • Some error handling is a bit wonky, but would be ironed out if I had more time.
  • React components could be better separated to keep it more DRY. At the moment the edit and add states use very similar forms.
  • Dockerize everything to make it easier to spin up.
  • Sorting has some wonkiness. It doesn't toggle sort directions when you click the headers a second time. Ironing out that logic would help.
  • There's no env config used. I hard coded values for my local PostgreSQL instance, but in a real world scenario these would be out of the repo.

task-management-app's People

Contributors

jpeacock avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.