davidshare / stackoverflow-lite

StackOverflow-lite is a platform where people can as questions about challenges and get answers. They can also provide answers to other people questions.

StackOverflow-lite

StackOverflow-lite is a platform where people can ask questions about their challenges and get answers. They can also provide answers to other peoples' questions.

UI hosted on gh pages

https://davidshare.github.io/StackOverflow-lite/UI/index.html

Server side hosted on Heroku

https://stackoverflowlite-essien.herokuapp.com/

Table of Content

• Getting Started

• Prerequisites for installation

• Installation

• Test

• API End Points Test Using Postman

• Coding Style

• Features

• Built With

• Author

• License

• Acknowledgement

Getting Started

Prerequisites for installation

1. Node js

2. Express

3. Git

Installation

1. Clone this repository into your local machine:

e.g git clone https://github.com/davidshare/StackOverflow-lite

2. Install dependencies

e.g npm install.

3. Start the application by running the start script.

e.g npm start

4. Install postman to test all endpoints on port 3000.

Test

run test using 'npm test'.

API End Points Test Using Postman

HTTP VERB	ENDPOINT	FUNCTIONALITY
POST	/api/v1/questions	post a question
POST	/api/v1/questions/:id/answers	post an answer
GET	/api/v1/questions	Gets all questions
GET	/api/v1/questions/:idd	Gets a question by id

Coding Style

• Airbnb style guide.

Features

Questions

• A user can post a question.
• A user can view all questions.
• A user can view a question using the id.
• A user can post an answer to a question.

Built With

• NodeJs-EXPRESS: Node.js is a javascript runtime built on Chrome's V8 javascript engine.

• html5: It is used for structuring the frontend.

• css: It is used for styling the frontend.

• Vannila Javascript: It is used for scripting the client side.

Author

• David Essien

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgement

I acknowledge the individuals from the organisation and groups below. They were a great source of motivation in completing this project.

• Andela.
• Andela Learning Facilitators.
• Andela cycle 35