Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidcopano/storybookmarks
Save your bookmarks online
https://github.com/davidcopano/storybookmarks
axios bookmark bookmark-manager bookmarks bookmarks-manager bootstrap bootstrap4 font-awesome jquery scss sweetalert symfony symfony3 vue vuejs vuejs2
Last synced: about 1 month ago
JSON representation
Save your bookmarks online
- Host: GitHub
- URL: https://github.com/davidcopano/storybookmarks
- Owner: davidcopano
- License: mit
- Created: 2018-06-13T15:52:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T00:41:24.000Z (over 1 year ago)
- Last Synced: 2024-09-30T16:02:57.514Z (about 2 months ago)
- Topics: axios, bookmark, bookmark-manager, bookmarks, bookmarks-manager, bootstrap, bootstrap4, font-awesome, jquery, scss, sweetalert, symfony, symfony3, vue, vuejs, vuejs2
- Language: PHP
- Homepage: https://storybookmarks.dcopano.xyz/
- Size: 6.53 MB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Storybookmarks
This project allows you to save your bookmarks online, among other functions.
## Getting Started
### Prerequisites
To install and run the project locally you must have the following tools installed:
- [Composer](https://getcomposer.org/download/)
- [NodeJS](https://nodejs.org/)
- [NPM](https://www.npmjs.com/get-npm)
### Installing
Once you have installed these tools, run these commands on a terminal:
- Clone the project:
```
git clone https://github.com/davidcopano/storybookmarks.git
```
- Install the project dependencies:
```
composer install
```
During the installation you will be asked for some parameters (data related to the database, data to send emails...).
- Install front end dependencies:
```
npm install
```
- Build .scss and .js bundles (use ``--watch`` flag for build when this files changes):
```
./node_modules/.bin/encore dev
```
- Build .scss and .js bundles for production:
```
./node_modules/.bin/encore production
```
- Finally, run the project:
```
php bin/console server:run
```
## Deployment
I followed [this guide](https://symfony.com/doc/3.4/deployment.html), made by the guys at Symfony, to deploy the project on my server.
## Testing funcionalities
If you don't want to install the project locally, or if you do not want to register with your own data, you can use these test credentials to log in and test the features [on the website](https://storybookmarks.dcopano.xyz/):
- Username: **user**
- Password: **password**
## Built with
- [Symfony](https://symfony.com/) - PHP framework for web applications
- [Encore](https://symfony.com/doc/3.4/frontend/encore/installation.html) - Front end tasks
- [VueJS](https://vuejs.org/) - Some client functionalities
- [Bootstrap](https://getbootstrap.com/) - CSS framework
- [SCSS](https://sass-lang.com/) - For custom Bootstrap styles and my own CSS
- [jQuery](https://github.com/jquery/jquery) - JavaScript library
- [FontAwesome](https://fontawesome.com/) - Cool icons
- [SweetAlert2](https://github.com/sweetalert2/sweetalert2) - Cool alerts
- [Axios](https://github.com/axios/axios) - AJAX requests
## Authors
- **David Copano** - _Initial work_ - [davidcopano](https://github.com/davidcopano)
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/davidcopano/storybookmarks/blob/master/LICENSE.md) file for details.