ekundayo-ab/phonebook

A Full-Stack Phone Book application built with ReactJS/Redux, NodeJS & Postgres

Phonebook Application

Phonebook

A Phonebook application for managing and organising contacts

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development

Prerequisites

Ensure you have these setup on your machine

• NodeJS - Server environment for running javascript
• Postgres - Database used
• Sequelize CLI - Object relational mapper for running migrations etc

Setting up

1. Clone this repository to your directory locally like so git clone [email protected]:ekundayo-ab/phonebook.git
2. Rename the .env.sample file in the root of the project directory to .env and change the DB_USER, DB_NAME and DB_PASS as it applies to you.
3. From the terminal cd into the project directory and run npm install
4. Run the model migrations with sequelize db:migrate For Development
5. Open two terminals and enter npm run server-dev on one and npm run client-dev on another For Production
6. Open two terminals and enter npm run server-prod on one and npm run client-prod on another
7. Navigate to url provided in the terminal for the client-dev to see the application or access through the url provided by your production hosting platform.

Built With

• Bootstrap - Open source toolkit for developing with HTML, CSS, and JS.
• React.js - A JavaScript library for building user interfaces
• Redux - A predictable state container for JavaScript apps.
• Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine
• Express.js - Fast, unopinionated, minimalist web framework for Node.js
• PostgreSQL - Open source database
• Sequelize - Sequelize is a promise-based ORM for Node.js v4 and up.

Authors

• Ekundayo Abiona - Initial work - ekundayo-ab