LIREST

The knownledge platform for every nerds, anything about book and beyond that..

Description

Lirest web application is the place where users or customers can dive deep into humanity knownledge: read, research, discover and share all their wisdoms in every fields to each other. Besides, it will allow any vendors or merchant or anyone with valuable resources to sell, trade off or auction right in the app.

Features (Available in version 0.1.0)

• Authentication flow (login and register)
• Get users information by their ids

Features (In progress)

• Edit users information
• Upload image

Tech Stack

Lirest uses a number of open source projects to work properly:

• VueJS - HTML enhanced for web apps!
• NodeJS - evented I/O for the backend
• Express - fast node.js network app framework
• TypeScript - a superset of typed JavaScript that can help build and manage large-scale JavaScript projects
• MySQL- an open source relational database management system
• TypeOrm- library that makes it easy to link your TypeScript application up to a relational database

Installation

Lirest requires NodeJS v10+ to run.

Clone the repo to your local

# Or git clone git@github.com:tranlam1997/Lirest-Homepages-API.git if you have SSH installed.
git clone https://github.com/tranlam1997/Lirest-Homepages-API.git
cd Lirest-Homepages-API

Install dependencies

pnpm install

Run the service

pnpm run dev

Build the service

pnpm run build

Note: You will need some credentials such as database config to be able to run the service. Head to config folder and change the default.yaml content

License

MIT