/zssn

ZSSN frontend implementation

Primary LanguageJavaScript

Zombie Survival Social Network

This project is a implementation of the ZSSN front-end ZSSN problem

Getting Started

To work locally on this project, navigate to the desired folder, and type in the following command:

Then open the repository folder/files in a text editor of your preference. To install all the dependencies type in :

  • npm install

(PS: you'll need to install npm first if you don't have it. NPM

Then you can start a development server, by the following command:

  • npm install

Prerequisites

As mentioned above, you need to install NPM.

Folder Structure

This project was bootstrapped with create-react-app, and so, follow it's basic folder structure:

zssn/
  README.md
  node_modules/
  package.json
  public/
    index.html
  src/
    App.css
    App.js
    App.test.js
    index.css
    index.js

This structure is important for create-react-app scripts, so be mindfull if you want to change it.

Architecture and Style

The projects main code is inside the folder src/. For this project, the react components were dived in to 3 folders:

  • /presentational
  • /container
  • /selfcontained

following the Redux and Functional Programing practices.

In presentational, are the components whose purposes are only to generate UI. In container, are the components with deal with data. In selfcontained are the components who don't fit perfecly in either of the abovve.

Finaly there are two adicional folders inside src:

  • /rest
  • /tests

In rest are the files who deal with data requisition. And in test are the test files.

Available Scripts

NOTE: This sections is a copy of create-react-app default README

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.