You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+99-1Lines changed: 99 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,16 @@
13
13
14
14
A Fully Async-based backend for [Code Inbox](https://github.com/wiseaidev/code-inbox).
15
15
16
+
---
17
+
16
18
## Development Requirements
17
19
18
20
- Make (GNU command)
19
21
- Python (>= 3.9)
20
22
- Poetry (1.6)
21
23
24
+
---
25
+
22
26
## Project Structure
23
27
24
28
<details>
@@ -46,6 +50,8 @@ A Fully Async-based backend for [Code Inbox](https://github.com/wiseaidev/code-i
46
50
47
51
</details>
48
52
53
+
---
54
+
49
55
## Installation with Make
50
56
51
57
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
293
299
294
300
> <http://localhost:8000/redocs>
295
301
302
+
---
303
+
296
304
## Deployments
297
305
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
+

321
+
322
+
1. Click the "New" button on the Render dashboard to create a new environment.
323
+

324
+
325
+
1. Connect your Git repository to Render by selecting the repository and branch you want to deploy.
326
+

327
+
328
+
1. Configure the environment variables you need for this FastAPI application.
329
+

330
+
331
+
1. Click the "Create Web Service" button.
332
+

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:
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
+
298
361
### Deploy locally with Compose v2
299
362
300
363
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.
351
414
352
415
### Heroku
353
416
354
-
This button will only deploy the server.
417
+
This button will only deploy this server.
355
418
356
419
[](https://heroku.com/deploy?template=https://github.com/wiseaidev/code-inbox-server)
357
420
421
+
---
358
422
359
423
## Frequently Asked Questions
360
424
@@ -430,6 +494,36 @@ As an algorithm expert, your task is to generate a comprehensive algorithm tutor
430
494
431
495
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.
432
496
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
+
433
527
## Core Dependencies
434
528
435
529
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:
0 commit comments