Skip to content

Commit

Permalink
Replaced files with that of storylines-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
praneethravuri committed Sep 1, 2024
1 parent 3172a09 commit ff1919a
Show file tree
Hide file tree
Showing 129 changed files with 26,850 additions and 6,378 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
40 changes: 4 additions & 36 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,4 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
node_modules
.env
dist/
server/.env.local
62 changes: 33 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
# Contributing
# Contributing to StoryLines

Pull requests are welcome. For major changes, please [open a new issue](https://github.com/praneethravuri/storylines/issues/new) first to discuss what you would like to change.
We appreciate your interest in contributing to StoryLines! Your contributions are valuable in making our platform better. This guide will help you understand how to contribute effectively.

# Setup
## Pull Request Guidelines

1. Fork and clone the repo
Don't be concerned if you're unsure about any of these guidelines. We're here to help and guide you through the process.

2. Run ```npm i``` to install the dependencies
### Pull Request Titles

3. Create a branch for your **PR** with ```git checkout -b your-branch-name```
Each pull request title should begin with a semantic prefix that describes the primary purpose of the changes:

To keep master branch pointing to remote repository and make pull requests from branches on your fork, run:
* **feat**: Introduces a new feature
* **fix**: Addresses a bug
* **docs**: Changes or adds documentation
* **style**: Makes code style changes (whitespace, formatting, missing semicolons, etc.)
* **refactor**: Improves code structure without changing functionality
* **perf**: Enhances performance
* **test**: Adds or modifies tests
* **build**: Alters the build system or external dependencies
* **ci**: Updates CI configuration files and scripts
* **chore**: Performs routine tasks or maintenance
* **revert**: Reverts a previous commit

```bash
git remote add upstream https://github.com/praneethravuri/storylines.git
git fetch upstream
git branch --set-upstream-to=upstream/master master
Example of a well-formatted pull request title:
```
feat: implement search functionality for theme rooms
```

# Pull Request Guidelines


* **feat**: A new feature

* **fix**: A bug fix

* **docs**: Documentation only changes

* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
## Getting Started

* **refactor**: A code change that neither fixes a bug nor adds a feature
To contribute to StoryLines, follow these steps:

* **perf**: A code change that improves performance
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your contribution.
4. Make and commit your changes.
5. Push your changes to your fork on GitHub.
6. Submit a pull request to the main StoryLines repository.

* **test**: Adding missing tests or correcting existing tests
## Code of Conduct

* **build**: Changes that affect the build system or external
* **dependencies (example scopes: gulp, broccoli, npm)
By participating in this project, you agree to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing.

* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
## Questions or Concerns?

* **chore**: Other changes that don't modify src or test files
If you have any questions or concerns, please don't hesitate to open an issue in the [Issues](https://github.com/praneethravuri/storylines-v2/issues) section of the repository.

* **revert**: Reverts a previous commit
Thank you for contributing to StoryLines! Your efforts help make our platform better for everyone.
52 changes: 31 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

A free and open-source storytelling platform that empowers you to create, contribute, and craft your own unique narratives.

[Go to App](#) | [Documentation](#)
## Quick Links

- [Full Documentation](https://github.com/praneethravuri/storylines-v2/tree/main/docs)
- [Getting Started](https://github.com/praneethravuri/storylines-v2/tree/main/docs/getting-started.md)
- [API Reference](https://github.com/praneethravuri/storylines-v2/tree/main/docs/api-reference.md)
- [Contributing](https://github.com/praneethravuri/storylines-v2/tree/main/docs/contributing.md)

## Description

Expand All @@ -20,28 +25,33 @@ Start your storytelling journey with StoryLines today!
* Visualize story progressions with interactive tree flow diagrams
* Bookmark and organize your favorite stories
* Develop your own unique storylines with multiple branching paths
* Select your favorite stories and create your own storybook
* Share your stories and storylines with the community
* User-friendly and intuitive interface

## Tech Stack

* **Next.js**
* **React**
* **TypeScript**
* **MongoDB** with **Mongoose**
* **Tailwind CSS**
* **@xyflow/react**: Library for creating interactive node-based UIs and diagrams
* **Framer Motion**
* **Lucide React, React Icons, Radix Icons**: Icon library
* **next-themes**
* **Vercel**

## Star History

<a href="https://star-history.com/#praneethravuri/storylines&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=praneethravuri/storylines&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=praneethravuri/storylines&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=praneethravuri/storylines&type=Date" />
</picture>
</a>
* Vite
* Node.js
* Express.js
* React
* TypeScript
* MongoDB with Mongoose
* Tailwind CSS
* @xyflow/react
* Framer Motion
* Tabler Icons
* Shad-cn
* Magic-ui

## Documentation

For more detailed information about StoryLines, please refer to our [full documentation](https://github.com/praneethravuri/storylines-v2/tree/main/docs).

## Contributing

We welcome contributions! Please see our [Contributing Guide](https://github.com/praneethravuri/storylines-v2/tree/main/docs/contributing.md) for more details.

## License

[MIT License](LICENSE)
44 changes: 34 additions & 10 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,44 @@

## Supported Versions

Use this section to tell people about which versions of your project are
currently being supported with security updates.
Use this section to tell people about which versions of your project are currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
| 1.0.x | :white_check_mark: |
| < 1.0 | :x: |

## Reporting a Vulnerability

Use this section to tell people how to report a vulnerability.
We take the security of StoryLines seriously. If you have discovered a security vulnerability in our project, please follow these steps to report it:

Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
1. **Do Not** disclose the vulnerability publicly until it has been addressed by our team.

2. Please email us at pravdevrav@gmail.com with details of the vulnerability. If possible, encrypt your message using our PGP key (available on our website).

3. Include the following information in your report:
- Type of vulnerability
- Full paths of source file(s) related to the vulnerability
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the vulnerability, including how an attacker might exploit it

4. Allow us a reasonable amount of time to resolve the issue before disclosing it to the public or a third party. We aim to respond to security reports within 48 hours and will strive to keep you informed about our progress towards a fix.

## Security Update Process

When we receive a security bug report, we will:

1. Confirm the problem and determine the affected versions.
2. Audit code to find any potential similar problems.
3. Prepare fixes for all supported versions.
4. Release new security fix versions as soon as possible.


## Comments on this Policy

If you have suggestions on how this process could be improved, please submit a pull request or open an issue to discuss.

Thank you for helping to keep StoryLines and our users safe!
2 changes: 2 additions & 0 deletions client/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
npm-debug.log
18 changes: 18 additions & 0 deletions client/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parser: '@typescript-eslint/parser',
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
24 changes: 24 additions & 0 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
30 changes: 30 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: __dirname,
},
}
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
18 changes: 18 additions & 0 deletions client/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "default",
"rsc": false,
"tsx": true,
"tailwind": {
"config": "tailwind.config.js",
"css": "src/styles/global.css",
"baseColor": "slate",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "src/components",
"utils": "src/lib/utils",
"ui": "src/components/ui"
}
}
13 changes: 13 additions & 0 deletions client/dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM node:18

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

EXPOSE 3000

CMD ["npm", "run", "dev", "--", "--host", "0.0.0.0"]
Empty file added client/file.ts
Empty file.
13 changes: 13 additions & 0 deletions client/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/logo.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>StoryLines</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
Loading

0 comments on commit ff1919a

Please sign in to comment.