Blog

A blog application

Development

The application is written in JavaScript. To start working on it you need to install Node.js. The following command will install nvm a Node.js version manager.

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

Please refer to the projects README for any further instructions.

To check that you have Node.js installed run:

node --version
npm --version

App

Setup React Native development environment by following the React Native CLI Quickstart version of the official guide

Make sure to have a device or emulator setup before starting.

1. Run the Metro Bundler:

npx react-native start

2. Run the platform specific command to start the project:

Android:

npx react-native run-android

IOS:

npx react-native run-ios

Front-end

The front-end is built with React.js. To start the app run the following commands from the ./frontend directory:

1. Install dependencies:

npm install

2. Start the front-end app:

npm start

app should start at localhost:3000

3. Run tests:

npm test

Backend

1. Install PostgresSQL following this or any other guide.

2. Create user and database:

CREATE USER blog WITH PASSWORD 'blog';
create database blog;
alter database blog owner to blog;

3. Copy .env-sample to .env and add appropriate environment variables

4. Install dependencies:

npm install

5. Build TypeScript from src

npm run build

6. Migrate database tables:

npm run migration

7. Start the backend app:

npm start

To watch for changes in src and building automatically run npm run build:watch on a different terminal window.

app should start at localhost:8000

Notice

Please make sure the Front-end is running at localhost:3000 and the Backend is running at localhost:8000 before continuing with development.

Seed Data

To use some predefined data for development run npm run seed

TODO:

1. Add create-superuser script
2. Add a dev script to run build:watch while running start