✨ Veil-Client ✨

Welcome to the Veil-Client repository! 🎉 Deployment is coming soon, but for now, please follow the instructions below to deploy the client and server yourself.

-- imagine this is pretty

Veil is an amazing, interassante, and easy-to-use learning platform that ensures a tested curriculum and seamless growth in communication between cultures. 🚀

📑 Table of Contents

• Prerequisites
• Installation
• Usage
• Contribution
• License

Prerequisites

Before you begin, ensure that you have met the following requirements:

• You have a working installation of Node.js (version 14.x or higher) and npm (version 6.x or higher).
• You have a basic understanding of JavaScript and web development concepts.

Installation

To install Veil-Client, follow these steps:

1. Clone the repository:

git clone https://github.com/Tucker-Judge/Veil-Client.git

2. Change to the project directory:

cd Veil-Client

3. Install the required dependencies:

npm install

4. Build the project:

npm run build

Usage

After installing Veil-Client, you can start using it by following these steps:

1. Deploy the server component by following the instructions in the Veil-Server repository.

2. Optional -- Deploy the AI technology by following the instructions in the Chatbot repository - this is currently not supported! blame open ai for taking away my free dev api calls. scoundrels

3. Start the client by running: npm start

4. Access the Veil-Client in your browser by navigating to http://localhost:3002.

Contribution

If you'd like to contribute to Veil-Client, feel free to submit a pull request or open an issue to discuss your ideas.

License

Veil-Client is released under the MIT License.