Welcome to the Veil-Server repository! This is the server-side component of the Veil platform, a powerful and easy-to-use learning platform that provides a tested curriculum and seamless growth in communication between cultures.
Before you begin, ensure that you have met the following requirements:
- You have a working installation of
Ruby(version 2.7.x or higher) andRails(version 6.x or higher). - You have a basic understanding of Ruby on Rails and web development concepts.
To install Veil-Server, follow these steps:
- Clone the repository:
git clone https://github.com/Tucker-Judge/Veil-Server.git
- Change to the project directory:
cd Veil-Server
- Install the required dependencies:
bundle install
- Create and set up the database:
rails db:create rails db:migrate
After installing Veil-Server, you can start using it by following these steps:
- Start the server by running:
rails server
-
The server should now be running on
http://localhost:3000. You can access the API endpoints through this URL. -
To use the server with the Veil-Client, make sure the client is set up to communicate with the server's API. Follow the instructions in the Veil-Client repository to set up the client.
If you'd like to contribute to Veil-Server, feel free to submit a pull request or open an issue to discuss your ideas.
Veil-Server is released under the MIT License.