search

railwayapp / templates

Railway starters
https://railway.app
MIT License
330 stars 150 forks source link

[New]: Django REST Template #451

Open Grey-A opened 11 months ago

Grey-A commented 11 months ago

Contact Details

angobello0@gmail.com

Template URL

https://railway.app/template/Rj_70k

What does this template deploy?

Purpose of the Template

I created this template to simplify the process of starting a Django REST app for others. Instead of deploying a basic Django app and then extending it to add REST capabilities, this template provides a ready-to-use starting point for building Django RESTful APIs.

Repository Link

The GitHub repository for the template can be found here: Django Rest Starter Repository

Deployed Services

The template deploys the following services:

  1. Django: The core web framework used to build the RESTful API.
  2. PostgreSQL (via Railway): The database service used for storing application data.

Service Links

Reason for Creating a Separate Template

While there might be existing templates that deploy similar services, I created this separate template for specific reasons:

  1. Simplified Configuration: This template is designed to have minimal configuration and provide a straightforward starting point for Django REST projects. It avoids unnecessary complexities and is well-suited for beginners.

  2. Latest Updates: By creating a separate template, I can ensure that the template stays up-to-date with the latest versions of Django and other essential libraries. This is particularly beneficial when working on a new project, as it avoids any potential compatibility issues that might arise from using older templates.

  3. Focused Approach: This template is tailored specifically for Django REST apps, ensuring that the deployed services and initial project structure are optimized for building APIs. It follows best practices and encourages a more focused development approach.

By using this template, developers can get started with their Django REST projects more efficiently and concentrate on building their application's unique functionalities without worrying about the initial setup.

Demo project

https://railway.app/project/04e32fbc-e27a-4a31-9438-73fd306d26a9

ndneighbor commented 10 months ago

The demo project doesn't seem to show off the API and is oddly specific to one project.

Also the repo linked doesn't seem to have a readme, can that be added?

Grey-A commented 10 months ago

ill make a readme immediately, and regarding the demo project its for one of my projects that i used the template for. Im a bit confused about what is referred to as a demo project, if you can tell me a brief overview of what qualifies as a demo project then i will be more than happy to make one

Grey-A commented 10 months ago

i added the readme, please let me know if you want me to edit it

ndneighbor commented 10 months ago

Hey there,

Not to move the goalpost a bit, so the README is great- however, I don't see any default routes that come with this project. It has the project scaffold but can we have some basic functionality that will prove that the API works?

Grey-A commented 10 months ago

Alright I'll add a default route, a simple one that says Hello world will be good or something else?