https://github.com/tcoppex/entrequote-webapp
:star2: EntreQuote helps you save and explore citations taken around the web.
https://github.com/tcoppex/entrequote-webapp
citations quotes ruby sinatra vuejs webapp
Last synced: 7 months ago
JSON representation
:star2: EntreQuote helps you save and explore citations taken around the web.
- Host: GitHub
- URL: https://github.com/tcoppex/entrequote-webapp
- Owner: tcoppex
- License: mit
- Created: 2018-04-09T11:34:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-20T06:54:19.000Z (about 5 years ago)
- Last Synced: 2025-01-17T00:50:52.369Z (9 months ago)
- Topics: citations, quotes, ruby, sinatra, vuejs, webapp
- Language: Vue
- Homepage:
- Size: 125 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EntreQuote
★ ***EntreQuote*** ★ helps you save and explore citations taken around the web 🌠
This repository contains the web application, consisting of :
* A RESTful API server built with *Ruby* and *Sinatra*,
* A front client built with *Vue.js*.
For the web-extension used to communicate with it, please refers to the [entrequote-webextension](https://github.com/tcoppex/entrequote-webextension) repository.
## Quickstart
### Project setup
We will use the `yarn` and `bundle` packages manager to install dependencies and compile both frontend and backend code.
```bash
# Install dependencies for the frontend
yarn
# Install Ruby dependencies for the backend.
bundle install
```
_Note : if the bundle installation fails you might need to install the ruby development package for your system (eg. `ruby-dev` on Debian)._
### Run the server
To compile and serve the application, simply type :
```
yarn run serve
```
This will start a server set by default to your available local addresses on port *4567*.
You can then visit the application from your [localhost](http://127.0.0.1:4567).
_Note : if you got an error on conflicting json version, you can refer to [Sinatra issue #1294](https://github.com/sinatra/sinatra/issues/1294) for a solution._
## Project structure overview
* The project root directory contains configurations files :
- *config.ru* > back-end running script (Rakes),
- *Gemfile* > back-end ruby packages,
- *package.json* > front-end packages,
- *webpack.config.js* > front-end compilation configuration.
* **app/** contains the back-end server code.
* **db/** contains database data.
* **public/** is the server root to be served containing the final compiled files.
* **resources/** contains the front-end code.
## License
*EntreQuote* is released under the *MIT License*.