User Generated Articles

This app is a React Native and TypeScript CRUD platform that allows users to view, create, update, and delete posts, as well as adding comments to the posts.

Note: For now, only user with the id 1 is permitted to edit or delete posts. If you like to try it out then the username is: afk0901 and password is 12345. Only then you should see an edit and deletion option.

It demonstrates the author's proficiency in React Native and TypeScript. It serves as a CRUD application built with React Native, showcasing the ability to:

• Integrate external APIs: The app connects to a custom-built Django REST API developed by the author.

• Perform core operations: Create, Read, Update, and Delete functionalities are implemented, reflecting robust application logic and user interaction.

This project is a work in progress, emphasizing the author's capability to develop full-stack solutions, including both the frontend (React Native) and backend.

Table of contents

1. Features
2. Remote API documentation
3. Local installation
4. Known bugs
5. Constraints

Features

• Public Content Viewing: All posts and comments are publicly visible without the need for authentication.

• Secure User Registration: Users can register to the platform to contribute to the content.

• Token-based Authentication: Actions such as posting, updating, and deleting content are secured with JWT authentication on integrated backend API.

• CRUD Operations: Full support for creating, reading, updating posts. Supports comments creation. Note tho, comments do not persist in the system yet.

Remote API documentation

API-documentation is accessable on the API here

Local installation

Prerequisites

• NodeJS installed on your computer

Installation

1. Clone the Repository to your local machine

   Run the following command to clone the project:

   git clone https://github.com/afk0901/User-Generated-Articles.git
   

2. Install Dependencies

   Run the following command to install dependencies:

   With NPM:

   npm install
   

   With Yarn:

   yarn install 
   

   or simply:

   yarn
   

3. Start the Development Server Run the following command to run the development server locally:

npm start

Running the tests

The project has some unit tests. To run them simply run:

npm test

Known bugs

• When creating comments they don't persist on the API - functionality WIP.

• Error handling - it's a work in progress, but empty inputs should be validated now if user clears enters them and exits them (focus/unfocus) or if the user clears everything out but on submit it wont validate and the form will submit no matter what.