Merge pull request #2 from codeupify/docs

acidcoder1 · web-flow · commit 3a27ffa49316 · 2024-10-30T13:01:33.000-06:00
Adding a docs github pages site
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Upify
 
-<img align="right" src="assets/carbon.png" />
+<img align="right" src="docs/assets/carbon.png" />
 
 A platform-agnostic CLI tool that simplifies cloud deployment for applications
 
@@ -17,6 +17,16 @@ A platform-agnostic CLI tool that simplifies cloud deployment for applications
 - Frameworks: Flask, Express
 - Runtimes: Python, Node.js
 
+## Documentation
+
+View the [online documentation](https://codeupify.github.io/upify):
+
+* [Getting Started](https://codeupify.github.io/upify/getting-started)
+* [Commands](https://codeupify.github.io/upify/commands)  
+* [Configuration](https://codeupify.github.io/upify/configuration)
+* [Wrappers](https://codeupify.github.io/upify/wrappers)
+* [Environment Variables](https://codeupify.github.io/upify/environment-variables)
+* [Provider Authentication](#provider-authentication)
 
 ## Installation
 
@@ -71,6 +81,10 @@ upify init
 
 This command will generate config and wrapper files. Depending on the options selected, you may need to adjust the generated code and config files. Follow the instructions provided in the command output.
 
+#### Environment Variables
+
+Add environment variables to `.upify/.env`
+
 ### Add a platform
 
 To add cloud platform support, run:
@@ -87,18 +101,18 @@ To deploy your project, use the following command:
 upify deploy [platform]
 ```
 
-*Note: You must have your cloud credentials set up before deploying. See the [Authentication](#authentication) section for more details.*
+*Note: You must have your cloud credentials set up before deploying. See the [Authentication](#provider-authentication) for more details.*
 
 ## Example projects
 
-- [Flask](/examples/flask/README.md)
-- [Express](/examples/express/README.md)
-- [Python without a framework](/examples/python/README.md)
-- [Javascript without a framework](/examples/javascript/README.md)
-- [Typescript without a framework](/examples/typescript/README.md)
+- [Flask](/examples/flask)
+- [Express](/examples/express)
+- [Python without a framework](/examples/python)
+- [Javascript without a framework](/examples/javascript)
+- [Typescript without a framework](/examples/typescript)
 
 
-## Authentication
+## Provider Authentication
 
 ### AWS - Lambda
 
@@ -228,7 +242,4 @@ Required APIs:
 - Cloud Build API
 - Artifact Registry API
 - Cloud Resource Manager API
-- Cloud Storage API
-
-
-
+- Cloud Storage API
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,30 @@
+title: Upify
+description: Upify documentation
+remote_theme: just-the-docs/just-the-docs
+
+markdown: kramdown
+plugins:
+  - jekyll-relative-links
+  - jekyll-seo-tag
+
+aux_links:
+  "Upify on GitHub":
+    - "//github.com/codeupify/upify"
+
+nav_enabled: true
+
+nav:
+  - title: Home
+    url: /upify/
+  - title: Getting Started
+    url: /upify/getting-started
+  - title: Commands
+    url: /upify/commands
+  - title: Configuration
+    url: /upify/configuration
+  - title: Wrappers
+    url: /upify/wrappers
+  - title: Environment Variables
+    url: /upify/environment-variables
+  - title: Provider Authentication
+    url: https://github.com/codeupify/upify#provider-authentication
diff --git a/docs/assets/carbon.png b/docs/assets/carbon.png
diff --git a/docs/assets/demo.tape b/docs/assets/demo.tape
diff --git a/docs/commands.md b/docs/commands.md
@@ -0,0 +1,36 @@
+---
+layout: default
+title: Commands
+permalink: /commands
+nav_order: 3
+---
+
+# Commands
+
+## init
+Initialize a new project.
+
+```bash
+upify init
+```
+
+## platform add
+Add platform support to your project.
+
+```bash
+upify platform add aws-lambda
+upify platform add gcp-cloudrun
+```
+
+## deploy
+Deploy your application to the specified platform.
+
+```bash
+upify deploy aws-lambda
+upify deploy gcp-cloudrun
+```
+
+## Flags
+
+### Global
+- `--help`: Display help information
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -0,0 +1,47 @@
+---
+layout: default
+title: Configuration
+permalink: /configuration
+nav_order: 4
+---
+
+# Configuration
+
+Configuration is stored in `.upify/config.yaml`.
+
+## Basic Configuration
+```yaml
+name: project-name
+framework: flask | express | none
+language: python | nodejs
+package_manager: pip | npm
+entrypoint: main.py
+app_var: app
+```
+
+## AWS Lambda Configuration
+```yaml
+aws-lambda:
+  region: us-east-1
+  role_name: lambda-role
+  runtime: python3.12 | nodejs20.x
+```
+
+## GCP Cloud Run Configuration
+```yaml
+gcp-cloudrun:
+  region: us-central1
+  project_id: your-project-id
+  runtime: python312 | nodejs20
+```
+
+## Reference
+
+| Field | Description |
+|-------|-------------|
+| name | Project name |
+| framework | Web framework being used |
+| language | Programming language |
+| package_manager | Package management tool |
+| entrypoint | Main application file |
+| app_var | App variable name in entrypoint |
diff --git a/docs/environment-variables.md b/docs/environment-variables.md
@@ -0,0 +1,19 @@
+---
+layout: default
+title: Environment Variables
+permalink: /environment-variables
+nav_order: 6
+---
+
+# Environment Variables
+
+Environment variables for your application should be placed in `.upify/.env`. These variables will be automatically loaded and set during deployment.
+
+Example `.upify/.env`:
+```bash
+API_KEY=your-api-key
+DATABASE_URL=your-database-url
+NODE_ENV=production
+```
+
+All variables in this file will be available to your application at runtime on the cloud platform.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,50 @@
+---
+layout: default
+title: Getting Started
+permalink: /getting-started
+nav_order: 2
+---
+
+# Getting Started
+
+## Installation
+
+### Go Install
+```bash
+go install github.com/codeupify/upify@latest
+```
+
+### Pre-built Binaries
+
+#### Linux and macOS
+1. Download from [releases page](https://github.com/codeupify/upify/releases)
+2. Move to PATH:
+```bash
+mv upify /usr/local/bin/
+chmod +x /usr/local/bin/upify
+```
+
+#### Windows
+1. Download from [releases page](https://github.com/codeupify/upify/releases)
+2. Add binary location to system PATH
+
+## Quick Start
+
+1. Initialize project:
+```bash
+upify init
+```
+
+2. Set environment variables in `.upify/.env` (see [Environment Variables](./environment-variables))
+
+3. If you aren't using a web framework, you'll need to add code to your wrappers (see [Wrappers](./wrappers))
+
+4. Add cloud platform:
+```bash
+upify platform add aws-lambda
+```
+
+5. Deploy:
+```bash
+upify deploy aws-lambda
+```
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,29 @@
+---
+layout: default
+title: Home
+permalink: /
+nav_order: 1
+---
+
+# Upify Documentation
+
+Upify is a platform-agnostic CLI tool that simplifies cloud deployment for applications, focusing on serverless architectures.
+
+## Sections
+
+* [Getting Started](/upify/getting-started)
+
+* [Commands](/upify/commands)
+
+* [Configuration](/upify/configuration)
+
+* [Wrappers](/upify/wrappers)
+
+* [Environment Variables](/upify/environment-variables)
+
+* [Provider Authentication](https://github.com/codeupify/upify#provider-authentication)
+
+
+## Example Projects
+
+Visit our [examples directory](https://github.com/codeupify/upify/tree/main/examples) for sample implementations
diff --git a/docs/wrappers.md b/docs/wrappers.md
@@ -0,0 +1,68 @@
+---
+layout: default
+title: Wrappers
+permalink: /wrappers
+nav_order: 5
+---
+
+# Wrappers
+
+Upify uses wrapper files to adapt your application for cloud deployment:
+
+## `upify_handler.[ext]`
+This file is automatically generated for all projects to handle cloud platform integration. You shouldn't have to modify this file.
+
+```python
+import os
+from main import app
+
+handler = None
+
+if os.getenv("UPIFY_DEPLOY_PLATFORM") == "aws-lambda":
+    from apig_wsgi import make_lambda_handler
+    handler = make_lambda_handler(app)
+if os.getenv("UPIFY_DEPLOY_PLATFORM") == "gcp-cloudrun":
+    import functions_framework
+
+    @functions_framework.http
+    def flask_function(request):
+        with app.request_context(request.environ):
+            return app.full_dispatch_request()
+
+    handler = flask_function
+```
+
+## `upify_main.[ext]`
+This file is only created for projects without a web framework. You'll need to modify it to adapt your non-web framework code to be able to handle HTTP requests/responses.
+
+```python
+from flask import Flask, request, jsonify
+
+""" ADD YOUR IMPORTS HERE """
+
+app = Flask(__name__, instance_path='/tmp')
+
+@app.route('/')
+def handler():
+    """ ADD YOUR CODE HERE """
+```
+
+### Example Implementation
+```python
+from flask import Flask, request, jsonify
+from main import get_weather_data
+
+app = Flask(__name__, instance_path='/tmp')
+
+@app.route('/')
+def handler():
+    city = request.args.get("city")
+    if city is None:
+        return jsonify({"error": "Specify a city"}), 400
+
+    try:
+        response_data = get_weather_data(city)
+        return jsonify(response_data), 200
+    except Exception as e:
+        return jsonify({"error": str(e)}), 500
+```
diff --git a/examples/flask/README.md b/examples/flask/README.md
