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
• NodeJS
• 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, 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:

• Username: user
• Password: password

Built with

• Symfony - PHP framework for web applications
• Encore - Front end tasks
• VueJS - Some client functionalities
• Bootstrap - CSS framework
• SCSS - For custom Bootstrap styles and my own CSS
• jQuery - JavaScript library
• FontAwesome - Cool icons
• SweetAlert2 - Cool alerts
• Axios - AJAX requests

Authors

• David Copano - Initial work - davidcopano

License

This project is licensed under the MIT License - see the LICENSE.md file for details.