Lantern

Backend development can be hard, long, and dark. Even more to produce modern, robust, production-ready APIs

Say hello to Lantern, your guide through the backend abyss

Lantern is currently under heavy development, so new features will be release soon ❤️

Don't hesitate to share your improvements or to give feedback on Discord (LeChatErrant#6074) :wink:

What is it ?

Lantern is an opinionated CLI to assist backend development

It aims to make backend development fast and easy, and focuses on generating maintainable code

| | |------------------------------------------------------------------------------------------| | V1 demo, will be updated soon ! And trust me, V2 is nothing like V1 ❤️ |

A lantern project follows a lot of good practices while staying entirely modifiable by developers

In summary, it simply gives you a guideline by writing boilerplate code

An example lantern project, serving as guidelines reference, can be found at API-template

Getting started

1. Install the CLI with npm install -g @lechaterrant/lantern
2. Simply run lantern to launch the CLI

Documentation

Documentation is currently being written and should be available soon. At this moment, simply refers to API-template wiki page

Roadmap

• [x] Finding a name and an identity
• [ ] Logo (WIP)
• [ ] Website
• [ ] Upgrade API resource generation
  • [x] Prisma parser to understand current datastructure
  • [x] Specify and custom fields
  • [x] Specify relations
  • [ ] Dynamically add middlewares
  • [ ] Select fields to be exposed
• [ ] New commands
  • [ ] Types sharing with front
  • [ ] Project bootstraping
  • [ ] Resource deletion
• [ ] Display
  • [x] v1
  • [x] Enhanced display v2
  • [ ] v3, using terminal layouts and more enhanced graphical features
• [x] Filesystem reverter for error during generation

How to contribute

1. Fork it (https://github.com/LeChatErrant/lantern/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Issues and comments welcomed ! :wink:

Contributors

  LeChatErrant - creator and maintainer