Skip to content

🛡️ A RESTful API microservice that generates human-readable xml dictionaries for your favourite fictional worlds. Dictionaries are built by parsing data consumed from MediaWiki.

License

Notifications You must be signed in to change notification settings

Runik-3/dictionary-generation-rest-service

Repository files navigation


Logo

Runik Dictionary Generation Microservice

🛡️ A RESTful API microservice that generates human-readable xml dictionaries for your favourite fictional worlds. Dictionaries are built by parsing data consumed from MediaWiki.

Search

Built With

  • Express
  • Docker
  • Prisma
  • TypeScript

Getting Started

1. Download starter and install dependencies

Clone this repository:

git clone [email protected]:Runik-3/dictionary-generation-rest-service.git

Install npm dependencies:

cd dictionary-generation-rest-service
npm install

2. Start Development Server

npm run dev

The server is now running on http://localhost:3000.

Usage

--

Roadmap

  • Add name splitting
  • Add more robust unit tests

See the open issues 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.

Contributors

This project exists thanks to all the people who contribute.

License

GPL-3.0 © Runik

Acknowledgments

About

🛡️ A RESTful API microservice that generates human-readable xml dictionaries for your favourite fictional worlds. Dictionaries are built by parsing data consumed from MediaWiki.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published