Git Product home page Git Product logo

contacts-server's Introduction

Contacts Manager Server

Portfolio piece for https://github.com/atwright147. This is the server side of a fairly simple contact manager application.

The aim of this repo is to demonstrate some of my development abilities in Express and the aim of the project as a whole is to demonstrate my abilities in:

  • Angular
  • React
  • Svelte
  • Express

Setup

This project uses @VSCode/SQLite which can be a pain to install, especially on Windows. Please follow their instruction to prepare your system for the installation (prepare node-gyp): https://www.npmjs.com/package/vscode-sqlite3#installing

Installation

npm ci

Copy .env.example to .env and update to taste

# migrate db, seed db and download avatar images
npm run setup

Running

npm run dev

The server will be available on http://localhost:3001/ and all API endpoints are under /api/v1/* (port is based on the .env file)

Tools

Database

I currently recommend using SQLectron as a GUI to work with SQL databases

Docker

A basic multi-stage Docker Compose file is set up to make it easier to run the application. This will watch for file changes andautomatically update them

  1. Run through the Installation steps (above)
  2. Copy the .env.example file to .env.docker and change the DB section to:
    # DB
    DB_PATH=/app/db
    DB_FILE=dev.sqlite3
  3. Run docker-compose up -d

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.