README.md

LangJournal

📕 A personal language learning journal.

Disclaimer

This project is no longer being maintained.

Sections

• Changelog
• Development
• Acknowledgements
• License

Changelog

All releases are documented in the project's changelog.

Development

Setup

Installing packages

npm install

Creating environment variables

The server uses cookie-session, Google Sign-In, and mLab, all of which require one or more environment variables; they must be set in a non-versioned .env file, following the template below.

COOKIE_SESSION_SECRET=...

GOOGLE_OAUTH_CLIENT_ID=...

GOOGLE_OAUTH_CLIENT_SECRET=...

MONGO_DB_DATABASE_NAME=...

MONGO_DB_URI=...

Building and running

Development mode

npm run dev

Production mode

npm run prod

Format checking

npm run checkFormatting

Linting

npm run lint

Releasing (and publishing)

Patches

npm run release

Minors

npm run release minor

Majors

npm run release major

Type checking

npm run checkTyping

Acknowledgements

• Fernando Coelho, Natália Medina, Rafael Bezerra: opinions, advice, and support.

• Eric A. Meyer: Reset CSS.

  • File here.
  • Original link: https://meyerweb.com/eric/tools/css/reset/index.html.

• John Sorrentino (Favicon.io): favicon.

  • File here.
  • Terms of use: https://favicon.io/terms-of-use/.

• Mozilla: language list.

  • Used here.
  • Original repository (with license): https://github.com/mozilla/language-mapping-list.

• Raph Levien: Inconsolata font.

  • Loaded here, and also used in the favicon.
  • Google Fonts page (with license): https://fonts.google.com/specimen/Inconsolata.

• Steve Schoger (Hero Patterns): repeatable SVG background.

  • Used here.
  • License: https://creativecommons.org/licenses/by/4.0/legalcode.

• Tobias Ahlin: box-shadow animation.

  • Used here.
  • Original link: http://tobiasahlin.com/blog/how-to-animate-box-shadow/.

  I'm also thankful to the maintainers and contributors of all open-source libraries used in this project; the direct dependencies are listed in the package.json file, and their corresponding dependencies and licenses are available at npm.

License

MPL 2.0