A application to store, update, create, delete, and read threw a sequelized && sqlite database.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
The dependencies you need to install the software, an how to install them :
-
NodeJS - As an asynchronous event driven JavaScript runtime, Node is designed to build scalable network applications.
- Learn more : https://nodejs.org/en/about/
-
Npm - npm makes it easy for JavaScript developers to share and reuse code, and makes it easy to update the code that you’re sharing, so you can build amazing things.
- Learn more : https://www.npmjs.com/get-npm
-
Express - Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications
- Learn more : https://expressjs.com/
-
Twitter API - Publish and analyze Tweets, optimize ads, and create unique customer experiences.
- Learn more : https://developer.twitter.com/en.html
-
Twit API - Twitter API Client for node (REST & Streaming API).
- Learn more : https://github.com/ttezel/twit
-
pugJS - high-performance template engine heavily influenced by Haml and implemented with JavaScript for Node.js and browsers
- Learn more : https://pugjs.org/api/getting-started.html
-
git - is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.
-
Homebrew - Homebrew installs packages to their own directory and then symlinks their files into /usr/local.
- Learn more - https://brew.sh
- Recommended install with brew.
- past the following into your Terminal
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Install nodeJS & npm with brew : past the following into your terminal
$ brew install node
- After install is complete check install using the following in your terminal.
For node -node -vthis will print out a version number like thisv10.6.0.
Now do the same for npm as followednpm -voutput will look something like this6.2.0.
To learn more please visit - node & npm install.
A step by step series of examples that tell you how to get a development env running
In your project root dir ('./') use the following command in your terminal.
$ git clone https://github.com/brandonv98/library-manager.git
Once you have cloned the repo $ cd/library-manager from here type $ npm install to install all of the project dependencies.
Back in our Terminal run npm start to start our server on localhost:3000.
Deployment ready.
NodeJS - An asynchronous event driven JavaScript runtime, Node is designed to build scalable network applications.
Express - minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
Sequelize - Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.
SQLite3 - SQLite is a C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine. SQLite is the most used database engine in the world. SQLite is built into all mobile phones and most computers and comes bundled inside countless other applications that people use every day.
- If you have recived the following error stack
throw new Error(`Please install ${moduleName} package manually`);
^
Error: Please install sqlite3 package manually
- How to fix - use
nvmto set node && npm version to, node -v : 11.15.0 && npm -v : 6.7.0.
- Brandon VanCamp - WebSite
This project is licensed under the MIT License - see the LICENSE.md file for details.
Yay Free software!