Skip to content

Home

Jump to bottom
John-Livingproof Fowowe edited this page Aug 13, 2024 · 4 revisions

Oculus Project Wiki

Welcome to the official Oculus Project Wiki! This space serves as a comprehensive guide to help you navigate through the various aspects of the project, from getting started to contributing and everything in between.

Overview

Oculus is an innovative SaaS solution designed to revolutionize the agricultural industry. It provides farmers with critical insights, tools, and analytics to optimize their agricultural operations. Our mission is to empower small-scale farmers with cutting-edge technology to achieve sustainable and profitable farming.

Table of Contents

  1. Getting Started
  2. Project Architecture
  3. Usage
  4. Contributing
  5. FAQ
  6. Troubleshooting
  7. Roadmap
  8. License
  9. Acknowledgements

Getting Started with Oculus

This section will guide you through the initial setup and configuration required to get Oculus up and running on your machine. Whether you're a developer looking to contribute or a user eager to try out the software, this guide has you covered.

Installation Guide

Prerequisites

Before you begin, make sure you have the following tools installed:

  • Node.js (v18.x or higher)
  • MongoDB (v4.x or higher)
  • Redis (optional, but recommended for caching)
  • Git (for version control)
  • A Code Editor (VS Code is recommended)

Step 1: Clone the Repository

First, clone the Oculus repository from GitHub to your local machine:

git clone https://github.com/johnlivingprooff/oculus.git
cd oculus

Step 2: Install Dependencies

Navigate into the project directory and install the necessary dependencies using npm:

npm install

Step 3: Set Up Environment Variables

Create a .env file in the root directory of the project and add the following environment variables:

NODE_ENV=development
PORT=3000
MONGODB_URI=mongodb://localhost:27017/oculus
REDIS_URL=redis://localhost:6379
JWT_SECRET=your_jwt_secret_key

Make sure to replace your_jwt_secret_key with a secure key of your choice.

Step 4: Start the Application

Now, you can start the application using the following command:

npm start

If everything is set up correctly, the application should be running on http://localhost:3000.

Configuration

For more advanced configuration options, refer to the Configuration Guide which covers topics such as deploying in production, using Docker, and customizing settings.

Quick Start

Here’s a quick start guide to using Oculus:

  1. Sign Up: Create a new account to start using the application.
  2. Add Fields: Enter details about your fields, including location and crop type.
  3. View Insights: Access real-time weather information, market analysis, and other insights related to your fields.
  4. Monitor Progress: Use the dashboard to track the performance of your crops over time.

For a more detailed walkthrough, check out the Usage section.

Clone this wiki locally