Skip to content

jlargs64/cognicraft-backend

Repository files navigation

cognicraft-backend

The backend for the CogniCraft app.

Features

Any features checked off means they're completed.

  • [] Create a simple course with examples and practice problems on any topic you'd like to learn about!
  • [] Ask questions about your course via RAG!
  • [] Share your courses with others by marking them public or private!

About

What is CogniCraft?

CogniCraft is an application that uses generative AI to create custom learning plans about ANY topic!

What does the name mean?

"CogniCraft" combines "Cognition" (relating to learning and knowledge) with "Craft" (suggesting customization and skillful creation).

Environment Set Up

  • Set up Ollama and install Llama 3.1 8b
  • Install requirements.txt
  • Fill out .env file

How to Run in Development

  • Enter fastapi dev app/main.py to run the dev server.

How to Run in Production

  • Run fastapi run
  • View docs locally here.
  • OpenAPI JSON File can be found here.

Testing

CI/CD Pipeline

About

A generative AI API for generating courses

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published