🧗‍ Your climbing best friend

App — Beta app — GitHub — Trello

📖 Table of Contents

• ❓ Why this application
• 🌈 How it works
• 🌎 Ecosystem
  • Highest client
  • Highest components
• 💻 Development
  • Environment setup
  • Building the app
  • Linting and fixing files
  • Customizing configuration
• 📜 Credits
• 🔐 License

❓ Why this application

Please note that the application is in beta : therefore, many bugs exist, and some features aren't implemented.

The Highest application aims to help climbers keep track -in one place- of their climbing activity. They can add routes to locations, define goals, upload photos and even register competitions to participate.

Highest is designed by and for climbers to improve at this beautiful discipline, in any form : outdoor, sport, bouldering, and even speed!

The future

This application will -I really hope- grow in order to have a place in the world of climbing. Exciting features, like statistics, a common database, account sync and many more are planned.

🌈 How it works

It's a website built on top of Vue.js that saves all of user's data into browser's storage, meaning no API is required at the back. Moreover, as it's a Progressive Web Application, it can load quickly and run offline.

The interface adapt itself if you're on a mobile device or on a computer : it takes part of user experiences on both systems.

Syncing options via an account are planned to be added in a near future, so the climbing data can be shared between devices.

🌎 Ecosystem

Highest client

• 📊 Trello board: follow the development of the application and planned features
• 🖥 Netlify dashboard: get a view of recent deploys of the website, so when new content is available. This public deploy log is a continuation of a fully open-source view.

Highest components

• 📦 Template: Front-end template used by Highest : Vue.js + Vuetify + A lot more
• 📜 API definition: view the architecture of the upcoming API

💻 Development

Thank you for being interested in helping the application to grow by expanding its code ! Please follow these few steps to get started. Note that you'll need on your local machine :

• Node.js v12+ with package manager (npm, yarn)
• Git, in any form : CLI, UI, GitHub...

Environment setup

First of all, download the project by cloning the repository from GitHub :

git clone https://github.com/highest-app/highest.git  # Using HTTP
git clone git@github.com:highest-app/highest          # Using SSH

Then, install the required dependencies using your favorite package manager :

npm install   # Using NPM
yarn install  # Using Yarn

Then, run the application using the serve command : (Make sure you installed Vue CLI on your system)

npm run serve  # Using NPM
yarn serve     # Using Yarn

A web server will start with hot reload enabled, perfect to develop.

Building the app

To get a built version of the application ready to be served by a HTTP server, use the build command :

npm run build  # Using NPM
yarn build     # Using Yarn

Files will be generated in the dist folder, and the entry point will be the index.html file.

Linting and fixing files

To lint the files and check for formatting, run the lint command :

npm run lint  # Using NPM
yarn lint     # Using Yarn

If a better formatting is available, new code will be written directly inside the concerned files.

Customizing configuration

If you want to customize the build configuration, check the Configuration Reference on the Vue CLI documentation.

📜 Credits

• Maintainer : Théo Vidal
• Main libraries : Vue.js, Vuetify
• Huge thanks to the many open-source package developers and undraw for the illustrations
• Contributors :
  • Hugo Lageneste: Highest logo, spanish translation

🔐 License

The Highest project is under the GNU GPL v3 license.