Skip to content

Commit 29ddba2

Browse files
committed
update README
1 parent 112ac93 commit 29ddba2

File tree

1 file changed

+99
-1
lines changed

1 file changed

+99
-1
lines changed

README.md

Lines changed: 99 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@
1313

1414
A Fully Async-based backend for [Code Inbox](https://github.com/wiseaidev/code-inbox).
1515

16+
---
17+
1618
## Development Requirements
1719

1820
- Make (GNU command)
1921
- Python (>= 3.9)
2022
- Poetry (1.6)
2123

24+
---
25+
2226
## Project Structure
2327

2428
<details>
@@ -46,6 +50,8 @@ A Fully Async-based backend for [Code Inbox](https://github.com/wiseaidev/code-i
4650

4751
</details>
4852

53+
---
54+
4955
## Installation with Make
5056

5157
The project is best configured, dependencies installed, and managed using the `make` utility. Therefore, it is essential to ensure that you have `make` properly installed and configured on your local machine before proceeding. Follow the steps below to install `make` on your specific operating system:
@@ -293,8 +299,65 @@ make run
293299

294300
> <http://localhost:8000/redocs>
295301

302+
---
303+
296304
## Deployments
297305

306+
### Render
307+
308+
Before we begin, make sure you have the following prerequisites:
309+
310+
1. A Render account (sign up at [Render](https://render.com/)).
311+
1. A fork of this repository to deploy.
312+
313+
#### Step 1: Set Up Your Repository
314+
315+
Make sure you've forked this project on GitHub. If it's not already, fork this repository. Render will deploy your application directly from your repository.
316+
317+
#### Step 2: Deploy to Render
318+
319+
1. Log in to your Render account.
320+
![Register for an OpenAI Account](static/openai-website.png)
321+
322+
1. Click the "New" button on the Render dashboard to create a new environment.
323+
![Register for an OpenAI Account](static/openai-website.png)
324+
325+
1. Connect your Git repository to Render by selecting the repository and branch you want to deploy.
326+
![Register for an OpenAI Account](static/openai-website.png)
327+
328+
1. Configure the environment variables you need for this FastAPI application.
329+
![Register for an OpenAI Account](static/openai-website.png)
330+
331+
1. Click the "Create Web Service" button.
332+
![Register for an OpenAI Account](static/openai-website.png)
333+
334+
Render will automatically build and deploy this FastAPI application based on these configuration.
335+
336+
#### Environment Variables
337+
338+
Ensure you set the following environment variables in your Render environment for your FastAPI application to function correctly:
339+
340+
- `MONGODB_USERNAME`
341+
- `MONGODB_PASSWORD`
342+
- `MONGODB_HOST` (e.g., `cluster_name.mongodb.net`)
343+
- `MONGODB_DATABASE` (e.g., `coding`)
344+
345+
- `NYLAS_SYSTEM_TOKEN`
346+
- `NYLAS_CLIENT_ID`
347+
- `NYLAS_CLIENT_SECRET`
348+
- `NYLAS_API_SERVER` (e.g., `https://api.nylas.com`)
349+
- `CLIENT_URI` (e.g., `http://localhost:3000`)
350+
351+
- `DEBUG` (e.g., `info`)
352+
353+
- `CORS_ORIGINS` (e.g., `localhost`)
354+
355+
- `DETA_PROJECT_KEY`
356+
357+
- `OPENAI_API_KEY`
358+
359+
Make sure to securely store and manage these environment variables in your Render environment settings for security and proper functionality of your FastAPI server.
360+
298361
### Deploy locally with Compose v2
299362

300363
First thing first, to run the entire platform, you have to clone the `code-inbox` submodule using the following command:
@@ -351,10 +414,11 @@ You'll need to create a Deta account to use the Deta version of the APIs.
351414

352415
### Heroku
353416

354-
This button will only deploy the server.
417+
This button will only deploy this server.
355418

356419
[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/wiseaidev/code-inbox-server)
357420

421+
---
358422

359423
## Frequently Asked Questions
360424

@@ -430,6 +494,36 @@ As an algorithm expert, your task is to generate a comprehensive algorithm tutor
430494

431495
OpenAI supports a wide range of programming languages for algorithm generation. Users can specify their preferred programming language when requesting algorithmic posts. Commonly supported languages include Python, Java, JavaScript, C++, and more.
432496

497+
---
498+
499+
## Upcoming Features
500+
501+
We are constantly working to enhance your experience on our platform. Here's a glimpse of some exciting features and improvements that we have in the pipeline:
502+
503+
### 1. **Expanded Programming Language Support**
504+
505+
We're adding support for even more programming languages, so you can generate algorithmic content in your language of choice.
506+
507+
## Upcoming Features
508+
509+
We are constantly working to enhance your experience on our platform. Here's a glimpse of some exciting features and improvements we have in the pipeline:
510+
511+
### 1. Advanced Algorithm Customization
512+
513+
We're developing a feature that will allow users to fine-tune the algorithmic posts generated by OpenAI even further. This means you'll have more control over the complexity, style, and specific aspects of the generated code to better match your unique requirements.
514+
515+
### 2. Integration with Additional Programming Languages
516+
517+
In our commitment to versatility, we're expanding the range of supported programming languages for algorithm generation. This will enable you to receive algorithmic content in the programming language of your choice, making it even more relevant to your needs.
518+
519+
### 3. User Feedback Integration
520+
521+
Your feedback is invaluable to us. We're implementing a dedicated feedback system within the platform, making it easier for you to share your thoughts, report issues, and suggest improvements. Your input will continue to shape our platform's evolution.
522+
523+
We're committed to delivering these features and more in the coming months. Your feedback and suggestions are invaluable to us as we continue to evolve and improve our platform. Stay tuned for updates and announcements!
524+
525+
---
526+
433527
## Core Dependencies
434528

435529
The following packages are the main dependencies used to build this project:
@@ -443,6 +537,10 @@ The following packages are the main dependencies used to build this project:
443537
- [`Nylas Python SDK`](https://github.com/nylas/nylas-python)
444538
- [`python-multipart`](https://github.com/andrew-d/python-multipart)
445539

540+
---
541+
446542
## License
447543

448544
This project and the accompanying materials are made available under the terms and conditions of the [`MIT LICENSE`](LICENSE).
545+
546+
---

0 commit comments

Comments
 (0)