Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theovidal/105app
📑 Website to store my school revisions
https://github.com/theovidal/105app
pwa revisions studies vuejs
Last synced: about 2 months ago
JSON representation
📑 Website to store my school revisions
- Host: GitHub
- URL: https://github.com/theovidal/105app
- Owner: theovidal
- License: gpl-3.0
- Created: 2020-03-28T16:54:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-14T17:20:45.000Z (over 1 year ago)
- Last Synced: 2024-05-29T22:46:56.927Z (8 months ago)
- Topics: pwa, revisions, studies, vuejs
- Language: Vue
- Homepage: https://105app.netlify.app
- Size: 20.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [🌈 How it works](#-how-it-works)
- [📬 Adding files](#-adding-files)
- [💻 Development](#-development)
- [Environment setup](#environment-setup)
- [Building the app](#building-the-app)
- [Linting and fixing files](#linting-and-fixing-files)
- [Customizing configuration](#customizing-configuration)
- [📜 Credits](#-credits)
- [🔐 License](#-license)
## 🌈 How it works
This simple app stores files in defined formats for example Microsoft Word and PDF, and then displays PDFs or JSON lists to the user. These files are organized by subjects, the user can search files and store them in personal, client-side libraries.
French students personally wrote these files that aim to help others during exam revisions.
## 📬 Adding files
If you want to add your own file to 105, head over to [the adding form](https://framaforms.org/soumettre-une-fiche-pour-105app-1593639677) and complete it!
## 💻 Development
Make sure you have NodeJS 12+ installed on your computer, as well as Git in any form - CLI, UI, GitHub...
### Environment setup
First of all, clone the repository from GitHub on your local machine : (this requires Git to be installed)
```bash
git clone https://github.com/theovidal/105app.git # Using HTTP
git clone [email protected]:theovidal/105app # Using SSH
```
Install the required dependencies using your favorite package manager :
```bash
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)
```bash
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 :
```bash
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 :
```bash
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](https://cli.vuejs.org/config/) on the Vue CLI documentation.
## 📜 Credits
- Main libraries : [VueJS](https://vuejs.org), [Vuetify](https://vuetifyjs.com)
- Maintainer : [Théo Vidal](https://github.com/theovidal)
## 🔐 License
This project is under the [GNU GPL v3](./LICENSE) license.
