yusur/salvi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

the big change

Browse source
This commit is contained in:
Yusur 2025-09-05 21:42:18 +02:00
parent 14e69ac291
commit 93e6b9a0d3
90 changed files with 2629 additions and 2900 deletions
Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -17,46 +17,47 @@ suitable as a community or team knowledge base.
+ Calendar
+ Works fine even with JavaScript disabled.
## Requirements
## Requirements & Dependencies
+ **Python** 3.6+.
+ **Python** <mark>3.10+</mark>.
+ **Flask** web framework (and Flask-Login / Flask-WTF / Flask-Arrest extensions).
+ **Peewee** ORM.
+ **SQLAlchemy** ORM.
+ **Markdown** for page rendering.
+ **Python-I18n**.
+ **[SUOU](https://github.com/yusurko/suou)**. <mark>(since 1.0)</mark>
* **Python-Dotenv**.
+ The database drivers needed for the type of database.
To install the dependencies, run (virtualenv advised):
> `pip install -e .`
## Usage
+ Clone this repository: `git clone https://github.com/sakuragasaki46/salvi`
+ Edit site.conf (old way) or .env (new way) with the needed parameters. An example site.conf with SQLite:
```
[site]
name = Salvi
[database]
directory = /path/to/database/
```
An example .env with MySQL:
+ Clone this repository: `git clone https://github.com/yusurko/salvi`
+ Edit `.env` with the needed parameters. An example `.env` with MySQL:
```
APP_NAME=Salvi
DATABASE_URL=mysql://root:root@localhost/salvi
```
+ Run `python3 -m app_init` to initialize the database and create the administrator user.
+ Run `python3 -m app_init` to initialize the database and create the administrator user. (The installer is unstable)
+ Run `flask run`.
+ You can now access Salvi in your browser at port 5000.
## Caveats
+ The whole application is untested.
+ If you forget the password, there is currently no way to reset it.
+ The whole application is free of unit tests. Ergo untested. No coverage.
+ If you forget the password, there is currently no way to reset it. E-mail is not supported as of 1.0.
+ This app comes with no content. It means, you have to write it yourself.
## License
[MIT License](./LICENSE).
Since 1.0, Salvi is licensed under the [Apache License, Version 2.0](LICENSE), a non-copyleft free and open source license.
Salvi`<=0.9` is under **[MIT license](LICENSE.0_9)**, available at `LICENSE.0_9`.
This is a hobby project, made available “AS IS”, with __no warranty__ express or implied.
I (sakuragasaki46) may NOT be held accountable for Your use of my code.
> It's pointless to file a lawsuit because you feel damaged, and it's only going to turn against you. What a waste of money you could have spent on a vacation or charity, or invested in stocks.