TELOSOMA

Welcome to the TELOSOMA repository! This README will guide you through setting up, working on, and contributing to the project. This is a link to the Documentation: TeloSoma Documentation

Table of Contents

• Project Setup
• Usage
• Pull Request Guidelines
• Authors
• License

Project Setup

Getting Started

1. Clone the Repository

• Clone this repository to your computer

  git clone https://github.com/The-Dragonss/TeleSoma.git
  

• cd into this folder:

  Telesoma
  

  • cd into this folder:

  frontend
  

• Install Dependancies:

  npm install
  

• Start the site

  npm run dev
  

• cd into this folder:

  backend
  

• Install Dependancies:

  npm install
  

• Start the server

  node server.js
  

Usage

To get started with development, follow these steps:

Instructions

• Create a .env file in the backend folder, that will have your openai key in this format

  OPENAI_API_KEY='your_openai_api_key'
  
  

1. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feat/your-feature-name

2. Make Your Changes

Work on your changes and commit them with descriptive messages:

git add .
git commit -m "Add a descriptive message about your changes"

2. Push to your branch

Push your branch to the remote repository:

git push origin feature/your-feature-name

Pull Request Guidelines

• Go to your repository on GitHub.
• You should see a notification about your recently pushed branch. Click on the "Compare & pull request" button.
• Add a title and description for your pull request, explaining the changes you’ve made.
• Click on "Create pull request."

Authors

• David Maigwa
• Shadrack Anyona
• Sharon Chang'ach

License

This project is licensed under a proprietary license.

Contribution

Fork this repository, contribute, and create a pull request.