mrmurdock11 / oclio

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.

oclio's Issues

Implement Book Management Functionality.

Use Cases:

• As an author, I want to add a new book to my library.
• As an author, I want to add information about the book before its creation (e.g., title, cover, synopsis, volume, category, genre).
• As an author, I want to see all of my books, whether published or not.
• As an author, I want to delete any book or collection of books.
• As an author, I want to update book information (e.g., title, cover, synopsis, volume).
• As an author, I want to add a new chapter to the book.
• As an author, I want to update any chapter.
• As an author, I want to delete any chapter.
• As an author, I want to change the order of the chapters.
• As an author, I want to publish/unpublish my book at any time.

Acceptance Criteria (AC):

• All use cases are implemented.
• Authors can successfully add new books to their library.
• Authors can provide detailed information about a book before its creation.
• Authors can view all books, both published and unpublished, in their library.
• Authors can delete any book or collection of books, and the system confirms the deletion.
• Authors can update book information, and changes are reflected immediately.
• Authors can add new chapters to a book, and the chapters are correctly associated with the book.
• Authors can update the content of any chapter, and changes are saved.
• Authors can delete any chapter, and the system confirms the deletion.
• Authors can rearrange the order of chapters within a book, and the new order is saved.
• Authors can publish or unpublish a book at any time, and the book's status is accurately reflected in the system.
• System validation ensures that all required book information is provided before creation.
• Notifications are sent to authors upon successful completion of actions (e.g., book added, chapter updated).
• The user interface is intuitive and user-friendly for all author interactions.
• All operations are completed without errors and within an acceptable response time.

Definition of Done (DoD):

• All acceptance criteria are met.

Implement Updating Title and Text for Existing Chapter.

Description:
Implement updating title and text for existing chapter.

Acceptance Criteria (AC):

• Endpoint exists for updating the existing chapter (e.g., [PUT] /api/v1/books/:bookId/chapters/:chapterId).

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Create a New Wireframe for The User Profile Page.

Description:
Create a new wireframe for the user profile page.

Acceptance Criteria (AC):

• [ ]

Definition of Done (DoD):

• All acceptance criteria are met.

Redesign of The Sign Up Page Wireframe.

Description
Redesign the wireframe of the Sign Up page to enhance the user experience and ensure better user engagement.

Acceptance Criteria (AC)

• New wireframe for the Sign Up page is created.
• The redesigned wireframe includes:
  • Clear and concise form fields (Full Name, Email, Password)
  • Intuitive Call-to-Action buttons (e.g., "Sign Up" and "Already have an account? Sign In")
  • Visual hierarchy for primary and secondary actions
• Incorporate design feedback after review with stakeholders

Definition of Done (DoD)

• All acceptance criteria are met.
• Wireframe is reviewed and approved by stakeholders.
• Wireframe is handed over to the development team.

Implement Deleting Existing Chapter in Book.

Description:
Implement deleting existing chapter from the specific book.

Acceptance Criteria (AC):

• Endpoint exists for saving user color theme (e.g., [DELETE] /api/v1/books/:bookId/chapters/:chapterId).

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Implement Creating the Book

Description:
Implement a new API endpoint to create the book. Users should be able to create a new book and start working with new ideas. Make sure that the book is created with a draft status, which means that only the user can see the book.

Acceptance Criteria (AC):

• Endpoint exists for creating the book (e.g., POST /api/v1/books).
• User creates the book with draft status.
• The book is empty (has no chapters, but has metadata about who created the book and when).
• Only authorized user can create a new book.

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Create a New Wireframe for The User Preferences Page.

Description:

Acceptance Criteria (AC):

• [ ]

Definition of Done (DoD):

• All acceptance criteria are met.

Implement Client for Books Management as Part of @oclio/clients Library.

Description:
Implement client for books management microservice as the part of @oclio/clients library for communication.

Acceptance Criteria (AC):

• Should be part of the `@oclio/clients' library.
• Create the BooksManagementModule module that exports the BooksManagementService from `@oclio/clients/books-management'.
• Should consist of payloads, results and clients.

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Implement Creating Chapter by Book ID

Description:
Implement creating a new chapter for an existing book by book ID.

Acceptance Criteria (AC):

• Endpoint exists for creating a new chapter (e.g., [POST] /api/v1/books/:id/chapters).

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Implement Getting Books by User ID

Description:
Implement a new API endpoint to get the books. Users should be able to get the books by user ID.

Acceptance Criteria (AC):

• Endpoint exists for getting the books by user ID (e.g., [GET] /api/v1/books).

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Implement The Book or Books Deleting Feature.

Description:
Implement the book or books deleting feature.

Acceptance Criteria (AC):

• Endpoint exists for deleting the book by book ID (e.g., [DELETE] /api/v1/books/{bookId}).
• Endpoint exists for deleting the books by book IDs (e.g., [DELETE] /api/v1/books) with body payload { bookIds: [{bookId}] }.

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Use SWC as Default Compiler.

Description:
Use SWC as a default compiler.

Acceptance Criteria (AC):

• ??

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.

Redesign of The Login Page Wireframe.

Description
Redesign the wireframe of the Login page to enhance the user experience and ensure better user engagement.

Acceptance Criteria (AC)

• New wireframe for the Login page is created.
• The redesigned wireframe includes:
  • Clear and concise form fields (Email, Password)
  • Intuitive Call-to-Action buttons (e.g., "Log In" and "Forgot Password?")
  • Visual hierarchy for primary and secondary actions
• Incorporate design feedback after review with stakeholders

Definition of Done (DoD)

• All acceptance criteria are met.
• Wireframe is reviewed and approved by stakeholders.
• Wireframe is handed over to the development team.

Implement Getting The Book by ID

Description:
Implement a new API endpoint to get the book. Users should be able to get the book by book ID.

Acceptance Criteria (AC):

• Endpoint exists for getting by book ID (e.g., [GET] /api/v1/books/:id).

Definition of Done (DoD):

• Code has been reviewed and approved by peers.
• All acceptance criteria are met.
• No existing functionality is broken.
• No console errors or warnings.