Skip to content

SNU-QUILL/FE

Repository files navigation

SNU quill

서울대학교 영자신문 동아리(SNU quill) 관리 페이지 개발 repository

license last-commit repo-top-language repo-language-count

Built with the tools and technologies:

TypeScript React Vite Radix-ui
React-Query React-Hook-Form Zod


Table of Contents

Overview

❯ REPLACE-ME


Features

❯ REPLACE-ME


Repository Structure

└── FE/
    ├── README.md
    ├── apps
    │   └── admin
    │       ├── .eslintrc.cjs
    │       ├── .gitignore
    │       ├── API 요청.md
    │       ├── README.md
    │       ├── components.json
    │       ├── index.html
    │       ├── package.json
    │       ├── postcss.config.js
    │       ├── public
    │       ├── src
    │       ├── tailwind.config.js
    │       ├── tsconfig.json
    │       ├── vercel.json
    │       └── vite.config.ts
    ├── package.json
    ├── packages
    │   ├── config-eslint
    │   │   ├── index.js
    │   │   └── package.json
    │   ├── config-typescript
    │   │   ├── base.json
    │   │   ├── package.json
    │   │   └── vite.json
    │   └── ui
    │       ├── .gitignore
    │       ├── README.md
    │       ├── components.json
    │       ├── eslint.config.cjs
    │       ├── index.html
    │       ├── package.json
    │       ├── postcss.config.js
    │       ├── public
    │       ├── src
    │       ├── tailwind.config.js
    │       ├── tsconfig.app.json
    │       ├── tsconfig.json
    │       ├── tsconfig.node.json
    │       ├── tsconfig.tsbuildinfo
    │       └── vite.config.ts
    ├── pnpm-lock.yaml
    ├── pnpm-workspace.yaml
    └── turbo.json

Modules

apps.admin
File Summary
components.json ❯ REPLACE-ME
tsconfig.json ❯ REPLACE-ME
index.html ❯ REPLACE-ME
postcss.config.js ❯ REPLACE-ME
vite.config.ts ❯ REPLACE-ME
package.json ❯ REPLACE-ME
.eslintrc.cjs ❯ REPLACE-ME
tailwind.config.js ❯ REPLACE-ME
vercel.json ❯ REPLACE-ME
packages.ui
File Summary
components.json ❯ REPLACE-ME
tsconfig.tsbuildinfo ❯ REPLACE-ME
tsconfig.json ❯ REPLACE-ME
eslint.config.cjs ❯ REPLACE-ME
index.html ❯ REPLACE-ME
postcss.config.js ❯ REPLACE-ME
tsconfig.app.json ❯ REPLACE-ME
vite.config.ts ❯ REPLACE-ME
package.json ❯ REPLACE-ME
tsconfig.node.json ❯ REPLACE-ME
tailwind.config.js ❯ REPLACE-ME
packages.config-typescript
File Summary
vite.json ❯ REPLACE-ME
base.json ❯ REPLACE-ME
package.json ❯ REPLACE-ME
packages.config-eslint
File Summary
package.json ❯ REPLACE-ME
index.js ❯ REPLACE-ME

Getting Started

Prerequisites

TypeScript: version x.y.z

Installation

Build the project from source:

  1. Clone the FE repository:
❯ git clone https://github.com/SNU-QUILL/FE
  1. Navigate to the project directory:
cd FE
  1. Install the required dependencies:
❯ npm install

Usage

To run the project, execute the following command:

❯ npm run build && node dist/main.js

Tests

Execute the test suite using the following command:

❯ npm test

Project Roadmap

  • Task 1: Implement feature one.
  • Task 2: Implement feature two.
  • Task 3: Implement feature three.

Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your github account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client.
    git clone https://github.com/SNU-QUILL/FE
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to github: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph


License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.


Acknowledgments

  • List any resources, contributors, inspiration, etc. here.

About

SNU QUILL FE MonoRepo(User, Admin)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors