Short is beautiful! Save the world by making it shorter!

General

⚠️ This project is a work in progress

Description

TODO

Project Structure

CLI (oclif based app)
Client (create-react-app based app)
Server (express server for app api)
Proxy (express server for hint route)
Sql (sql scripts used by server and proxy)

Install

You can skip this block if you are going to use it in dockerized environment. Everything is configured into docker-compose.yml, and all configurable parameters are defined into .env file.

Add this configuration to your hosts file to use the builtin nginx reverse proxy

172.28.1.1 app.shorty.local
172.28.1.1 api.shorty.local
172.28.1.1 proxy.shorty.local
172.28.1.1 mail.shorty.local

Pre-requisite for non-docker environment

MySQL >= 5.5.40
Node.js >= 10.15.0
Yarn >= 1.10.1 (optional)

Mail Service

Configure the mail service, if you are using a Gmail account, you can follow up this or this

Setup

Create a database and create tables with mysql -u username -p password database_name < ./sql/bootstrap/init.sql
Copy the .env file with cp env.dist .env and edit with your own data.
Then you can start the app with yarn dev for development environment or yarn prod for production.
Now it's time to create the first user via CLI app with ./cli/bin/run bootstrap --add-user, and follow up the instruction on the screen.
That's it. 🚀

To Do

🐳 Dockerize
🚦️ Test with Jest.
🚨 Enhance user handling with roles.
🌍 i18n
🚀 CI/CD Set up
🤖 Add Google Tag Manager for GA (Google Analytics)
🤯 Migrate to Typescript - Styled Components

Credit

Claudio Quaglia (Developer Frontend/Backend)

Gabriele Pellegrini (Designer/Developer Frontend)

Thanks

@Feries

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bsramin/shorty