-
This is a social news website serving as the frontend to the NC-Knews API for which the git can be found here.
The Web application allows a user to post new articles to existing topics, with the ability to create a
comment on each article, vote on articles and comments, login and logout, order articles by created, comment count and votes.
It is assumed that VS code (or another appropriate alternative) runs on your machine.
You also need node (at least v11.0.0) and npm (at least version 6.4.1) installed on your machine.
Fork the project from git. Then copy the git url and in the appropriate folder on your machine:
git clone <url from git>
This will create the project on your local machine. Open the project in VS code (or alternative app).
Run the following to install chai, express, nodemon, knex, mocha, pg & supertest.
npm install
Once all required dependencies are installed, you can check the node_modules folder (which should be created now) to see if the folders for each of these libraries exists.
Coming soon...
To run the app:
npm start
The front-end was developed using React the styling was done via React Bootstrap combined with css. I considered other frameworks such as semantics but I preferred the styling provided by React Bootstrap.
Testing was done with Cypress. Given the limited time, not all of the test cases were incorporated and will be done at a later date.
The database holding the article info is Postgres and Express was used to build the server. Supertest, Mocha and Chai were used for testing.
A Readme was created in order to check off things which needed to be done
- Hassan Bharu
- [git] https://github.com/HassanBharu