lukazc / classified

Image classification through machine learning

Getting Started

In the root directory of the project...

1. Install node modules yarn install or npm install.
2. Start development server yarn start or npm start.

Next Steps

Sample Data

Replace the sample data stored in /server/sampleData.js. Replace the default images stored in /src/images.

Adding a New Page

1. Create a folder in /src/app/app-shell with your angular modules.
2. Add a child route for your page to /src/app/*.module.ts.
3. Add a button to the navigation bar in /src/app/app-shell/nav-bar/nav-bar.component.html.

File Structure

The back-end is based on Express Generator. The front-end is based on Angular cli "ng".

The front-end is served on http://localhost:3000/ and the back-end on http://localhost:3001/.

.
├── server/ - Express server that provides API routes and serves front-end
│ ├── routes/ - Handles API calls for routes
│ ├── app.js - Adds middleware to the express server
│ ├── sampleData.js - Contains all sample text data for generate pages
│ ├── constants.js - Defines the constants for the endpoints and port
│ └── server.js - Configures Port and HTTP Server
├── src - Angular front-end
│ └── app - Angular main root module
│    ├── app-shell - Angular main components
│    └── app.module.ts - Angular root module.
└── README.md

Additional Documentation

• Angular Docs - https://angular.io/docs

• Angular Router - https://angular.io/guide/router

• Bootstrap CSS - https://getbootstrap.com/

• Express - https://expressjs.com/