This repository serves as a proof of concept, to illustrate an understanding of how Ruby on Rails can be used as an API backend, with a TypeScript React (embedded) frontend.
The use of the blog-client directory as an nested git repository is not a production safe strategy, as when utlising branches, and other git features, there may be some conflicted file and directory tracking. This could be mitagated by adding teh nested directory to the parents .gitignore file (and managing the nested directory separately), or using git submodules. The directory stucture has been left as is for this example, as is simply a proof of concept.
-
If you don't have them already installed, install Ruby and Ruby on Rails: https://gorails.com/setuptall
-
Clone this repository.
-
Navigate into the root of the repository and run
rails db:migrate. Once complete runrails cin the same directory. This will take you into the Rails console. -
When inside the console run
Articleand you should see a response similar to=> Article (call 'Article.lease_connection' to establish a connection). Then runArticle.create!(title: "My first blog post", body: "text"), replacing the text "text" with whatever text you would like. This will populate the SQLite database with some content. -
Once you've finished adding database entries, type
exitto leave the Rails console. -
Then navigate into the root of the repository and run
rails s; this may prompt you to install some other packages, by running something similar tobundle install --gemfile ~/Documents/ruby/RubyOnRails/blog/Gemfile, if so, run as is instructed in the terminal. -
Run
rails sagain and hopefully you'll get a running Ruby on Rails API backend. If so, visiting the 'Listening on' URL from the terminal, such as http://127.0.0.1:3000/api/v1/articles, in a browser should show a JSON response. -
Next, navigate into the blog-client directory and run
npm run dev, then navigate to the 'Local:' URL as specified in the terminal, which will hopefully display a populated page with some Blog articles.
