readme.md

Jobly Backend

This is the Express backend for Jobly, version 2.
Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A RESTful Node-Express backend to complement Jobly, my job-board app built with React. This app follows the REST architecture principals and returns JSON. Certain routes are protected vie JWT based auth middleware.

Built With

• Node
• Express
• JWT
• JSON Schema
• Postgres
• PG

(back to top)

Getting Started

Dev environment uses a local postgres database. Site is deployed with a postgres hobby db.

Prerequisites

To run locally, install psql for Postgres

• Instructions for HomeBrew on ios

    $ brew install postgresql
    $ brew pin postgresql
    $ brew services start postgresql
    $ psql CREATE DATABASE jobly

Installation

1. Clone the repo

   git clone https://github.com/calebthewood/express-jobly

2. Install NPM packages

   npm install

3. Run in Development mode

   run start

4. Run Jest Tests

   run test
   

(back to top)

Roadmap

• Generate Random Password for one time use.
• Implement PostgreSQL's enum type for 'state' column
• Add technologies/skills for Jobs (many-to-many)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Questions? - I'm on twitter @calebthewood - or email: [email protected]

Personal Site

Acknowledgments

• Rithm School

(back to top)