This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
Zaimki/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2021-09-07 11:01:52 -07:00
# Zaimki.pl / Pronouns.page
2020-07-22 13:19:23 -07:00
## Build Setup
```bash
# install dependencies
2020-10-13 12:49:08 -07:00
$ make install
2020-07-22 13:19:23 -07:00
# configure environment
$ nano .env
2020-09-28 11:11:51 -07:00
$ make switch LANG=pl
2020-07-22 13:19:23 -07:00
# serve with hot reload at localhost:3000
2020-10-13 12:49:08 -07:00
$ make run
2020-07-22 13:19:23 -07:00
# build for production and launch server
2020-10-13 12:49:08 -07:00
$ make deploy
$ nuxt start
2020-07-22 13:19:23 -07:00
```
## Copyright
2021-09-07 11:01:52 -07:00
See [LICENSE](./LICENSE.md)
2022-04-06 02:05:42 -07:00
## Development Documentation
Read https://en.pronouns.page/new-version
When you add a new language, remember to modify the file ./src/locales.js to add your language. true means the translation is finished and published, so you'll probably want to go with false.\
If you're having problems using Yarn, npm is probably fine, but remember to switch any `yarn [x]` commands for `npm run [x]`\
Remember to modify the ./.env file. You don't really need to set up any external APIs, just make up a secret. In order to test the login system, you can type in an email followed by a + (example@pronouns.page+). This way, you won't need a mailer, as the code will always be 999999. This feature is exclusive to development builds.
## Current translations being worked on
- Catalan - @peiprjs
- [Add yours!]