Giter VIP home page Giter VIP logo

note.io's Introduction

Note.io

Note.io is a dockerized note taking app focused on simplicity! This app is centralized around a mysql server and frontend ui in docker containers.

Usage & Installation

Docker-compose

Configuration

To configure the app, alter the variables within .env.
Take note for which variables are for what part of the app. Some variables apply to both the app and the database.
It is recommended to change password, username, and database root password.

To run in a production environment, the database host may need to be changed. Find this in the docker-compose.yaml

Usage

This is a dockerized app relying on docker-compose. To run, install docker and docker-compose. Then run the following:

$ docker-compose build
$ docker-compose up

This will start the required containers. To access the application, navigate to localhost:3000 in a web browser

NPM

install and run in the following order:

  1. Database
  2. Server
  3. Client

Database

Instructions

  1. Navigate to the database folder via $ cd database
  2. (Assuming mysql is already installed and configured) open mysql: $ mysql or $ sudo mysql
  3. source the database using msql> source Database.sql

Server

Instructions

  1. Open up a new terminal
  2. Navigate to the server folder via $ cd server/
  3. Install necessary dependencies with $ npm install
  4. Start the server with $ npm start

Client

Instructions

  1. Open any browser and go to localhost:3000

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.