https://github.com/kropanov/storycascade

A client-server system for a novel writing service
https://github.com/kropanov/storycascade

aws-s3 bcrypt javascript nestjs pinia postgresql typescript vite vue3 vuetify

Last synced: about 1 month ago
JSON representation

A client-server system for a novel writing service

• Host: GitHub
• URL: https://github.com/kropanov/storycascade
• Owner: Kropanov
• License: bsd-2-clause
• Created: 2024-02-17T18:43:18.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-07-11T10:02:43.000Z (6 months ago)
• Last Synced: 2024-07-11T22:02:47.463Z (6 months ago)
• Topics: aws-s3, bcrypt, javascript, nestjs, pinia, postgresql, typescript, vite, vue3, vuetify
• Language: TypeScript
• Homepage:
• Size: 956 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# StoryCascade

This repository contains two projects: a client-side application built with Vue.js version 3 and a server-side application built with Nest.js. These projects collectively form StoryCascade, a service for writing and reading novels in English.

## Projects

### Vue3 Client

The Vue3 Client is a front-end application developed using Vue.js version 3. It provides an interactive interface for users to write, read, and manage novels. The client-side application utilizes modern technologies to ensure a seamless user experience.

#### Technologies Used:

- Vue.js 3

- Vuetify

- Pinia

- Vue Router

- Vite

### NestJS Server

The NestJS Server is a back-end application developed with Nest.js, a progressive Node.js framework. It serves as the backbone of the StoryCascade service, handling authentication, data storage, and providing an API for communication between the client and the database.

#### Technologies Used:

- Nest.js

- PostgreSQL

- JWT

- AWS SDK

- bcrypt

- TypeScript

## Getting Started

To run these projects locally, follow these steps:

1. Clone this repository to your local machine.

2. Navigate to the `client` directory and the `server` directory separately.

3. Install dependencies for both projects using `npm install`.

4. Configure environment variables for the server (e.g., PostgreSQL connection string, JWT secret).

5. Start the server by running `npm start:dev` in the `server` directory.

6. Start the client by running `npm run dev` in the `client` directory.

7. Access the application in your web browser at `http://localhost:3000` for the client and `http://localhost:4000` for the server.

## Contributing

Contributions to StoryCascade are welcome! If you have ideas for new features, find bugs, or want to improve the codebase, feel free to submit issues and pull requests.

## License

This project is licensed under the BSD 2-Clause License - see the [LICENSE](LICENSE.md) file for details.