Lucky Realworld Example App

This is an implementation of the realworld backend spec written using Lucky.

Setting up the project

1. Install required dependencies
2. Update database settings in config/database.cr
3. Run script/setup
4. Run lucky dev to start the app

Testing using postman/newman

to launch test, we use newman

POSTMANCOLL=Conduit.auth.postman_collection.json APIURL=http://localhost:5000/api postman/run-api-tests.sh

Learning Lucky

Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides.

Documentation about API specs

https://github.com/gothinkster/realworld/tree/master/api

Progress

• User
  • Authentication
  • Registration
  • Get Current User
  • Update User
• Get Profile
• Follow user
• Unfollow user
• Create Article
• List Articles
  • Filter by tag
  • Filter by author
  • Favorited by user
  • Limit number of articles (default is 20)
  • Offset/skip number of articles (default is 0)
• Feed Articles
  • Limit number of articles (default is 20)
  • Offset/skip number of articlse (default is 0)
• Get Article
• Update Article
• Delete Article
• Add Comments to an Article
• Get Comments from an Article
• Delete Comment
• Favorite Article
• Unfavorite Article
• Get Tags