Merge pull request #22 from Iank-code/documentation

docs: updated documentation

Author: Iank-code

.github/workflows/deploy.yml

@@ -28,6 +28,6 @@ jobs:
       - name: Build project
         run: npm run build
 
-        env:
-          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
-          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        # env:
+        #   NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+        #   NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Ian Kamau]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,36 +1,63 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# SIL 2.0
 
-## Getting Started
+## Table of Contents
 
-First, run the development server:
+- [Introduction](#build-your-own-introduction)
+- [Prerequisites](#build-your-own-prerequisites)
+- [Setup Instructions](#build-your-own-setup-instructions)
+- [Running the Application](#build-your-own-running-the-application)
+- [Trello Board](#build-your-own-trello-board)
+- [License](#build-your-own-license)
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+# Build your own `Introduction`
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+This documentation provides a comprehensive guide on how to set up and run the Next.js application. Next.js is a React framework that enables functionality such as server-side rendering and static site generation.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+# Build your own `Prerequisites`
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+Before you begin, ensure you have met the following requirements:
 
-## Learn More
+- Node.js (version 12.0 or later)
+- npm or yarn (Node package managers)
+- Git (version control system)
 
-To learn more about Next.js, take a look at the following resources:
+# Build your own `Setup Instructions`
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+### Step 1: Clone the repository
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+First, clone the repository to your local machine using Git.
 
-## Deploy on Vercel
+        git clone git@github.com:Iank-code/SIL-2.0.git
+        cd SIL-2.0
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+### Step 2: Install dependencies
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Install the project dependencies using npm
+
+        npm install
+
+### Step 3: Create Environment Variables
+
+Create a `.env.local` file in the root directory and add your environment variables.
+
+        NEXT_PUBLIC_SERVER_URL="https://jsonplaceholder.typicode.com"
+        GOOGLE_CLIENT_ID="<YOUR GOOGLE CLIENT ID>"
+        GOOGLE_API_SECRET="<YOUR GOOGLE API SECRET>"
+
+### Step 4: Run the application
+
+Start the development server.
+
+        npm run dev
+
+# Build your own `Running the Application`
+
+After setting up, you can access the application at `http://localhost:3000`
+
+# Build your own `Trello Board`
+
+For project management and task tracking, please refer to my Trello board: [Project Trello Board](https://trello.com/b/GgF8qU5t/savannah-informatics-frontend-developer)
+
+# Build your own `License`
+
+This project is licensed under the MIT License. See the LICENSE file for more information.