C.I.K.U - Cognitive Interface for Knowledge and Understanding
CIKU-AI is a Phoenix-based application designed to provide a conversational chatbot interface, enabling users to discuss their problems in a supportive and interactive environment. 😊
Before getting started, ensure you have the following installed on your system:
- Elixir (version 1.14 or later)
- Phoenix (version 1.7 or later)
- PostgreSQL (version 13 or later)
Follow these steps to set up and run CIKU-AI locally:
-
Clone the repository
git clone https://github.com/your-username/ciku-ai.git
-
Navigate to the project directory
cd ciku-ai
-
Install dependencies
mix setup
-
Set up environment variables
Create a.env
file in the root directory and add the following variables:export DB_USERNAME="your_postgres_username" export DB_PASSWORD="your_postgres_password" export API_KEY="your_api_key"
Then, load the environment variables:
source .env
-
Start the Phoenix server
You can start the server in one of two ways:- Standard mode:
mix phx.server
- Interactive Elixir mode (IEx):
iex -S mix phx.server
- Standard mode:
-
Access the application
Open your browser and visit http://localhost:4000.
You can also access the live version of CIKU-AI here:
👉 https://cikuai.newtonmutugi.me
We welcome contributions from the community! If you'd like to contribute, please follow these steps:
- Fork the repository and create your branch from
main
. - Open an issue to discuss the changes you'd like to make (especially for major changes).
- Submit a pull request with a clear description of your changes.
Please ensure your code adheres to the project's coding standards and includes appropriate tests.
For any questions, issues, or feedback, feel free to reach out by opening an issue on the repository or contacting the maintainer.
Happy coding! 🚀