Skip to content
This repository has been archived by the owner on Jul 11, 2022. It is now read-only.

Latest commit

 

History

History
157 lines (102 loc) · 3.31 KB

README.md

File metadata and controls

157 lines (102 loc) · 3.31 KB

LangJournal

Build status

📕 A personal language learning journal.

Screenshot of the home page

Disclaimer

This project is no longer being maintained.

Sections

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

License

MPL 2.0