Skip to content

Latest commit

 

History

History
155 lines (114 loc) · 7.07 KB

README.md

File metadata and controls

155 lines (114 loc) · 7.07 KB
Raw

angular-calendar : An angular calendar SPA

Table of contents

Description

Angular Calendar is a project whose goal is to develop a single-page application that presents a weekly calendar, with Angular. This project is a view of the days of the week, where the user can see any event he created during that week.

The user can change the selected date and display any week he wants. The displayed events will be updated depending on the days.

The user can create a new event, by clicking on the calendar. A dialog will open with a default event set to one hour meeting, where he clicked. The user can also create a new event by clicking on the create button located at the top left of the application. The default event will be set at the current hour, one hour meeting.

The created event is always depending on the user selected. By default, there are only three users logged (Xavier, Corentin and Gaultier)

The user can edit a created event, and change start date, end date, title and color. He can also delete the event.

Interactions

The application is a unique weekly calendar view representing all the meeting of the user Xavier.

Calendar view

The application enables to create new events thanks to a create button, or selecting a already created event, and edit it.

Creation Form

User Limitations :

The calendar being developed in one week duration, it presents at the moment several user limitations :

  • No check is done on start date and end date. Please enter a correct date.
  • No Undo/Redo is possible. If you deleted an event by mistake, you can create it again.
  • No keyboard actions are developed.
  • No basic interaction, like click/extend new event, preview of new event, drag and drop of event.

Technologies

angular-calendar is created with:

  • Angular CLI: 8.3.20
  • Node: 12.13.0
  • OS: win32 x64
  • Angular: 8.2.14

Package version

  • @angular-devkit/architect 0.803.20
  • @angular-devkit/build-angular 0.803.20
  • @angular-devkit/build-optimizer 0.803.20
  • @angular-devkit/build-webpack 0.803.20
  • @angular-devkit/core 8.3.20
  • @angular-devkit/schematics 8.3.20
  • @angular/cdk 8.2.3
  • @angular/cli 8.3.20
  • @angular/material 8.2.3
  • @angular/material-moment-adapter 8.2.3
  • @ngtools/webpack 8.3.20
  • @schematics/angular 8.3.20
  • @schematics/update 0.803.20
  • momentjs 2.24.0
  • rxjs 6.4.0
  • typescript 3.5.3
  • webpack 4.39.2

angular-calendar notably takes advantage of Material Angular for UI, or MomentJS for storing dates.

Here is a non exhaustive list of libraries used :

  • MomentJS
  • Material Angular : Radio Box, Card, Date picker etc.
  • Reactive Forms
  • RxJS

Launch

To run this project, install it locally using npm:

# Clone this repository
$ git clone https://github.com/xaviermarchal/angular-calendar.git
# Go into the repository
$ cd angular-calendar
$ npm install
$ ng serve

The project will be usable on http://localhost:4200/

Code architecture

This application, build under Angular with Redux pattern, considers three differents models :

  • selectedDate : the current date by default, stored with MomentJS. The user can change this date with all pickers provided.
  • Calendar Event : events associated to a day in the calendar. An event is associated to a unique user.
  • User : User management
export class CalendarEvent {
    constructor(
        public id: string,
        public title: string,
        public startDate: moment.Moment,
        public endDate: moment.Moment,
        public userId: string,
        public color?: string
    ) {}
}

export class User {
    constructor(
        public id: string,
        public fname: string,
        public name: string,
        public color: string,
        public selected = false
    ) {}
}

All these data are stored in a global store, using ngrx :

// use entities for managing events and users updates
export interface AppState {
    readonly events: CalendarEventsState;
    readonly selectedDate: moment.Moment;
    readonly users: UserState;
}

Actions and reducers are available in the folder Store.

This applications embeds seven different components :

  • Three main components for the global view :

    -Nav-Bar : Navigation bar. This component provides actions on the selected date, with possibility to reset the date to today, or switch to next/previous week.

    -Side-Bar : Left side bar. This component enables to change the selected date with a date Picker. You can also create a new event and switch the selected user whom the application is displaying his events.

    -Calendar : Main component displaying the calendar. This component acts like a container, managing the store and giving information to sub components to be displayed. For now, this component fixes the current viewType to 'week' type, and makes the hours always displayed ( this could be an improvement of the app.).

  • Three components used by calendar

    -Day-view : The day view. This component renders a view for the current day, and its list of all events associated. Each event is displayed thanks to a CSS padding system. Each hour represents around 40px (fixed value, but could be changed in a near future). The day view launches the dialog form for creating events, and emit these events once they are created/edited to its parent.

    -Calendar-event : The event view. This component displays a colored box given the event information (color, title, dates).

    -Event-form : The form component for creating/editing an event. Given an event, displays by default the event values in the form fields.

  • One component used by side-bar

    -User : This component provides a radio group view of the user list available. When a user is selected, it raises an event to inform its parent that a selection change has been done. The user list is fixed in the project.