/vocascan-server

Server for Vocascan

Primary LanguageJavaScriptApache License 2.0Apache-2.0


Logo

A highly configurable vocab trainer

Report Bug · Request Feature · Docs · Discord

shield-license shield-issues shield-stars shield-forks shield-downloads shield-docker

About The Project

Digitalization is creating a huge change in the world. We no longer only have the chance to communicate with our fellow human beings in the vicinity, but to interact quickly and easily around the entire globe. Language is our most important medium, which helps us to interact with the other person. A common language helps to make life easier and to break barriers. That's why we founded Vocascan, a server-client based open-source vocabulary trainer. We believe that everyone should have the chance to learn another language for free and in their own way. Based on the ever-proven principle of flashcards, we have developed a highly configurable trainer that has many settings to adapt it to your learning methods and strategies.

Core Features

  • 🔥 Easy to set up
  • ☁️ Synchronize any device
  • ⚙️ Many settings

Built With

Sequelize Nodemon Chalk ESLint Prettier Swagger Expressjs

Supported Databases

PostgreSQL MySQL MariaDB SQLite

Getting Started

To use Vocascan you need to host a server. We recommend to run the whole setup on a Linux distribution. Currently we provide three documented examples to set up your own server. Depending on your requirements, you should find a method that suits your needs. If you're unsure which option is best for you, feel free to check out the pros and cons here.

  1. PM2
  2. Docker
  3. Docker + Traefik

If any questions have come up, it's best to check out our FAQ. If they are still not answered, feel free to contact a maintainer. Check the contact section for more information

Roadmap

  • Integration tests
  • Port whole Code to TypeScript

See the project board for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

For a more detailed instruction about contributing visit our contribution docs.

License

Distributed under the Apache 2 License. See LICENSE for more information.

Contact

Vocascan - @vocascan - vocascan@gmail.com - Discord

Project Link: https://github.com/vocascan/vocascan-server