diff --git a/.github/workflows/docusaurus.yml b/.github/workflows/docusaurus.yml deleted file mode 100644 index 209b96f9..00000000 --- a/.github/workflows/docusaurus.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Docs - -on: - push: - branches: [main, dev] - paths: - - "docs/**" - pull_request: - branches: [main, dev] - paths: - - "docs/**" - - -jobs: - deploy: - name: Deploy to GitHub Pages - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: Set up node - uses: actions/setup-node@v3 - with: - node-version: 16 - - - name: Build docs - run: | - cd docs - yarn install - yarn build - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs - user_name: github-actions[bot] - user_email: 41898282+github-actions[bot]@users.noreply.github.com \ No newline at end of file diff --git a/backend/streetdrop-api/build.gradle b/backend/streetdrop-api/build.gradle index 4f975d49..78140109 100644 --- a/backend/streetdrop-api/build.gradle +++ b/backend/streetdrop-api/build.gradle @@ -21,6 +21,7 @@ dependencies { implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2' implementation 'org.springframework.boot:spring-boot-starter-validation' implementation 'org.springframework.boot:spring-boot-starter-data-redis' + implementation 'org.springframework.boot:spring-boot-starter-cache' implementation 'org.springframework.boot:spring-boot-starter-actuator' runtimeOnly 'io.micrometer:micrometer-registry-prometheus' implementation 'io.micrometer:micrometer-core' @@ -35,6 +36,8 @@ dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' implementation 'io.awspring.cloud:spring-cloud-starter-aws:2.3.1' + implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310' + implementation 'com.fasterxml.jackson.core:jackson-databind' } test { diff --git a/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/request/NearItemRequestDto.java b/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/request/NearItemRequestDto.java index 371bffc3..cb270c45 100644 --- a/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/request/NearItemRequestDto.java +++ b/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/request/NearItemRequestDto.java @@ -11,6 +11,7 @@ import org.springdoc.core.annotations.ParameterObject; import org.springframework.validation.annotation.Validated; + @Getter @NoArgsConstructor @AllArgsConstructor diff --git a/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/response/ItemsResponseDto.java b/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/response/ItemsResponseDto.java index b0c0ec54..c8326cf3 100644 --- a/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/response/ItemsResponseDto.java +++ b/backend/streetdrop-api/src/main/java/com/depromeet/domains/item/dto/response/ItemsResponseDto.java @@ -1,8 +1,8 @@ package com.depromeet.domains.item.dto.response; +import com.depromeet.domains.music.dto.response.MusicResponseDto; import com.depromeet.domains.user.dto.response.UserResponseDto; import com.depromeet.item.Item; -import com.depromeet.domains.music.dto.response.MusicResponseDto; import com.fasterxml.jackson.annotation.JsonFormat; import io.swagger.v3.oas.annotations.media.Schema; diff --git a/backend/streetdrop-api/src/main/java/com/depromeet/external/redis/RedisConfig.java b/backend/streetdrop-api/src/main/java/com/depromeet/external/redis/RedisConfig.java new file mode 100644 index 00000000..96bcf658 --- /dev/null +++ b/backend/streetdrop-api/src/main/java/com/depromeet/external/redis/RedisConfig.java @@ -0,0 +1,71 @@ +package com.depromeet.external.redis; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.cache.annotation.EnableCaching; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.redis.cache.RedisCacheConfiguration; +import org.springframework.data.redis.cache.RedisCacheManager; +import org.springframework.data.redis.connection.RedisConnectionFactory; +import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer; +import org.springframework.data.redis.serializer.RedisSerializationContext; +import org.springframework.data.redis.serializer.StringRedisSerializer; + +import java.time.Duration; + +@Slf4j +//@Configuration +//@EnableCaching +public class RedisConfig { + + @Value("${spring.data.redis.host}") + private String host; + + @Value("${spring.data.redis.port}") + private int port; + + @Value("${spring.data.redis.timeout}") + private int timeout; + + @Bean + public RedisConnectionFactory redisConnectionFactory() { + log.info("Registered redisConnectionFactory"); + return new LettuceConnectionFactory(host, port); + } + + @Bean + public RedisTemplate redisTemplate() { + log.info("Registered redisTemplate"); + + RedisTemplate redisTemplate = new RedisTemplate<>(); + redisTemplate.setConnectionFactory(redisConnectionFactory()); + redisTemplate.afterPropertiesSet();; + return redisTemplate; + } + + @Bean(name = "redisCacheManager") + public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory) { + log.info("Registered CacheManager"); + + RedisCacheConfiguration configuration = RedisCacheConfiguration + .defaultCacheConfig() + .disableCachingNullValues() + .entryTtl(Duration.ofMinutes(timeout)) + .serializeKeysWith( + RedisSerializationContext + .SerializationPair + .fromSerializer(new StringRedisSerializer())) + .serializeValuesWith( + RedisSerializationContext + .SerializationPair + .fromSerializer(new GenericJackson2JsonRedisSerializer())); + + return RedisCacheManager.RedisCacheManagerBuilder + .fromConnectionFactory(connectionFactory) + .cacheDefaults(configuration) + .build(); + } +} diff --git a/backend/streetdrop-api/src/main/resources/application-dev.yml b/backend/streetdrop-api/src/main/resources/application-dev.yml index dfc05db9..7b5cf470 100644 --- a/backend/streetdrop-api/src/main/resources/application-dev.yml +++ b/backend/streetdrop-api/src/main/resources/application-dev.yml @@ -10,6 +10,15 @@ spring: jpa: hibernate: ddl-auto: update + cache: + type: redis + redis: + cache-null-values: true + data: + redis: + host: ${REDIS_HOST} + port: ${REDIS_PORT} + timeout: 30 swagger: server-url: ${SWAGGER_SERVER_URL} slack: diff --git a/backend/streetdrop-api/src/main/resources/application-prod.yml b/backend/streetdrop-api/src/main/resources/application-prod.yml index dfc05db9..7b5cf470 100644 --- a/backend/streetdrop-api/src/main/resources/application-prod.yml +++ b/backend/streetdrop-api/src/main/resources/application-prod.yml @@ -10,6 +10,15 @@ spring: jpa: hibernate: ddl-auto: update + cache: + type: redis + redis: + cache-null-values: true + data: + redis: + host: ${REDIS_HOST} + port: ${REDIS_PORT} + timeout: 30 swagger: server-url: ${SWAGGER_SERVER_URL} slack: diff --git a/docs/blog/authors.yml b/docs/blog/authors.yml index c9421fa6..eef61153 100644 --- a/docs/blog/authors.yml +++ b/docs/blog/authors.yml @@ -17,23 +17,3 @@ siyeon: url: https://github.com/siyeonSon image_url: https://github.com/siyeonSon.png - -endi: - name: Endilie Yacop Sucipto - title: Maintainer of Docusaurus - url: https://github.com/endiliey - image_url: https://github.com/endiliey.png - -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png - - diff --git a/docs/docs/database-schema /_category_.json b/docs/docs/database-schema /_category_.json deleted file mode 100644 index b89e94cb..00000000 --- a/docs/docs/database-schema /_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Database Schema", - "position": 5, - "link": { - "type": "generated-index" - } -} \ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 8a2e69d9..a047804b 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -2,46 +2,24 @@ sidebar_position: 1 --- -# Tutorial Intro +# Intro(개요) -Let's discover **Docusaurus in less than 5 minutes**. +Street Drop Docs는 Street Drop의 공식 문서입니다. -## Getting Started +## Street Drop 이란? +스트릿드랍은 길을 걸으며 음악을 드랍하는 음악 공유 소셜 서비스예요 -Get started by **creating a new site**. +[**디프만(디자이너와 프로그래머가 만났을 때)**](https://www.depromeet.com/) 13기 프로젝트로 진행되었으며, 2023년 3월부터 시작하여, 2023년 7월에 공개베타 서비스를 오픈하여 운영중입니다. -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. -### What you'll need +사이드 프로젝트로 진행된 만큼 다양한 문서와 작업 과정, 코드등을 공개하고 있습니다. -- [Node.js](https://nodejs.org/en/download/) version 16.14 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. +### Street Drop Docs 란? +Street Drop Docs는 **Street Drop의 공식 문서**이며 SRS 문서, 여러 개발자 문서 등을 확인할 수 있습니다. +Street Drop Docs는 [_Docusaurus_](https://docusaurus.io/)를 사용하여 만들어졌습니다. -## Generate a new site +### Street Drop SRS +Street Drop SRS는 Street Drop의 SRS 문서입니다. -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. +### Street Drop SDD +Street Drop SDD는 Street Drop의 SDD 문서입니다. \ No newline at end of file diff --git a/docs/docs/software-design-description/Intrduction.md b/docs/docs/software-design-description/Intrduction.md new file mode 100644 index 00000000..01461e42 --- /dev/null +++ b/docs/docs/software-design-description/Intrduction.md @@ -0,0 +1,7 @@ +--- +title: 1. Introduction (개요) +sidebar_position: 1 +--- + +# 1 Introduction (개요) +## 1.1 Purpose (목표) diff --git a/docs/docs/software-design-description/_category_.json b/docs/docs/software-design-description/_category_.json new file mode 100644 index 00000000..f8d07e78 --- /dev/null +++ b/docs/docs/software-design-description/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Software Design Description", + "position": 5 +} diff --git a/docs/docs/software-design-description/architecture.md b/docs/docs/software-design-description/architecture.md new file mode 100644 index 00000000..5395dc7e --- /dev/null +++ b/docs/docs/software-design-description/architecture.md @@ -0,0 +1,20 @@ +--- +title: 3. Architecture (아키텍처) +sidebar_position: 3 +--- + +# 3. Architecture +The architecture provides the top level design view of a system and provides a basis for more detailed design work +Provide or reference a detailed description and diagrams of the architecture.. + +## 3.1 Overview +This section provides a high level overview of the structural and functional decomposition of the system. Focus on how and why the system was decomposed in a particular way rather than on details of the particular components. Include information on the major responsibilities and roles the system (or portions) must play. + + +## 3.2 Subsystem, Component, or Module 1 …N +You only need to provide this level of detail for elements which are custom for this design. Do not go into gory detail. Goal is to get 80% of the elements figured out ahead of time. + +Describe an element (subsystem, component, module, etc.) from architecture in further detail. When appropriate, include information on how the element is further broken down and the interactions and relationships between these subcomponents. + +## 3.3 Strategy 1…N +Describe the strategy used or decision made. Include information on the alternatives considered and the reasons for their rejection. diff --git a/docs/docs/database-schema /database-schema.md b/docs/docs/software-design-description/database-schema.md similarity index 96% rename from docs/docs/database-schema /database-schema.md rename to docs/docs/software-design-description/database-schema.md index 3990f507..cabd7995 100644 --- a/docs/docs/database-schema /database-schema.md +++ b/docs/docs/software-design-description/database-schema.md @@ -1,6 +1,6 @@ --- -title: Database Schema -sidebar_position: 5 +title: 4. Database Schema (데이터베이스 스키마) +sidebar_position: 4 --- # Database Schema @@ -17,10 +17,10 @@ sidebar_position: 5 ## Schema 설계 ### 전체 ERD 다이어그램 -![](./images/ERD.png) +![](images/ERD.png) ### 사용자 관련 ERD 다이어그램 -![](./images/ERD-Users.png) +![](images/ERD-Users.png) 사용자 도메인에 대한 ERD 다이어그램 입니다. @@ -36,7 +36,7 @@ sidebar_position: 5 ### 드랍 아이템 관련 ERD 다이어그램 -![](./images/ERD-Items.png) +![](images/ERD-Items.png) 드랍 아이템 도메인에 대한 ERD 다이어그램 입니다. @@ -49,7 +49,7 @@ sidebar_position: 5 ### 음악 관련 ERD 다이어그램 -![](./images/ERD-Music.png) +![](images/ERD-Music.png) 음악 도메인에 대한 ERD 다이어그램 입니다. @@ -64,7 +64,7 @@ sidebar_position: 5 ### 지역 관련 ERD 다이어그램 -![](./images/ERD-Areas.png) +![](images/ERD-Areas.png) 지역 도메인에 대한 ERD 다이어그램 입니다. @@ -76,7 +76,7 @@ sidebar_position: 5 | 읍면동 및 마을 지역 | Village Area | village_area | 읍면동 및 마을 지역에 대한 정보를 담고 있습니다. 마을 지역 ID, 마을 명, 마을 코드, 버전, 마을 지역 폴리곤, 마을 중심지역, 도시지역 ID 필드가 있습니다. | ### 관리자 관련 ERD 다이어그램 -![](./images/ERD-Admin.png) +![](images/ERD-Admin.png) 관리자 도메인에 대한 ERD 다이어그램 입니다. diff --git a/docs/docs/software-design-description/design-considerations.md b/docs/docs/software-design-description/design-considerations.md new file mode 100644 index 00000000..fa82ed48 --- /dev/null +++ b/docs/docs/software-design-description/design-considerations.md @@ -0,0 +1,21 @@ +--- +title: 2. Design Considerations (설계 고려사항) +sidebar_position: 2 +--- +# 2. Design Considerations +All design considerations were handled in Binder Release Phase 1. + +## 2.1 Assumptions +Metrics and TaskView reports will be handled in the workflow reporting project. + +## 2.2 Constraints +None that we are aware of. + +## 2.3 System Environment +The Binder Request Workflow process resides in the PCMS system which is a VB.NET application that resides on the client’s machine that has an XP operating system. PCMS is the banking practice’s global desktop that will be available to all banking practice associates. The database used to store the data will be SQL Server. Teamplate will be used as the Third Party Workflow product.. + +## 2.4 Design Methodology +(Optional) - Summarize the approach that will be used to create and evolve the designs for this system. Cover any processes, conventions, policies, techniques or other issues which will guide design work. + +## 2.5 Risks and Volatile Areas +None have been identified. diff --git a/docs/docs/software-design-description/high-level-design.md b/docs/docs/software-design-description/high-level-design.md new file mode 100644 index 00000000..b90727c1 --- /dev/null +++ b/docs/docs/software-design-description/high-level-design.md @@ -0,0 +1,4 @@ +--- +title: 5. High Level Design (상위 수준 설계) +sidebar_position: 5 +--- diff --git a/docs/docs/database-schema /images/ERD-Admin.png b/docs/docs/software-design-description/images/ERD-Admin.png similarity index 100% rename from docs/docs/database-schema /images/ERD-Admin.png rename to docs/docs/software-design-description/images/ERD-Admin.png diff --git a/docs/docs/database-schema /images/ERD-Areas.png b/docs/docs/software-design-description/images/ERD-Areas.png similarity index 100% rename from docs/docs/database-schema /images/ERD-Areas.png rename to docs/docs/software-design-description/images/ERD-Areas.png diff --git a/docs/docs/database-schema /images/ERD-Items.png b/docs/docs/software-design-description/images/ERD-Items.png similarity index 100% rename from docs/docs/database-schema /images/ERD-Items.png rename to docs/docs/software-design-description/images/ERD-Items.png diff --git a/docs/docs/database-schema /images/ERD-Music.png b/docs/docs/software-design-description/images/ERD-Music.png similarity index 100% rename from docs/docs/database-schema /images/ERD-Music.png rename to docs/docs/software-design-description/images/ERD-Music.png diff --git a/docs/docs/database-schema /images/ERD-Users.png b/docs/docs/software-design-description/images/ERD-Users.png similarity index 100% rename from docs/docs/database-schema /images/ERD-Users.png rename to docs/docs/software-design-description/images/ERD-Users.png diff --git a/docs/docs/database-schema /images/ERD.png b/docs/docs/software-design-description/images/ERD.png similarity index 100% rename from docs/docs/database-schema /images/ERD.png rename to docs/docs/software-design-description/images/ERD.png diff --git a/docs/docs/software-design-description/low-level-design.md b/docs/docs/software-design-description/low-level-design.md new file mode 100644 index 00000000..2cd80017 --- /dev/null +++ b/docs/docs/software-design-description/low-level-design.md @@ -0,0 +1,4 @@ +--- +title: 6. Low Level Design (하위 수준 설계) +sidebar_position: 6 +--- diff --git a/docs/docs/software-design-description/user-interface-design.md b/docs/docs/software-design-description/user-interface-design.md new file mode 100644 index 00000000..70399ca6 --- /dev/null +++ b/docs/docs/software-design-description/user-interface-design.md @@ -0,0 +1,4 @@ +--- +title: 7. User Interface Design (사용자 인터페이스 설계) +sidebar_position: 7 +--- diff --git a/docs/docs/software-requirement-specification/_category_.json b/docs/docs/software-requirement-specification/_category_.json index f0f5de29..67efc301 100644 --- a/docs/docs/software-requirement-specification/_category_.json +++ b/docs/docs/software-requirement-specification/_category_.json @@ -1,8 +1,4 @@ { "label": "Software Requirements Specification", - "position": 4, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } + "position": 4 } diff --git a/docs/docs/software-test-specification/Integration-test-result.md b/docs/docs/software-test-specification/Integration-test-result.md new file mode 100644 index 00000000..7ab6c5fd --- /dev/null +++ b/docs/docs/software-test-specification/Integration-test-result.md @@ -0,0 +1,6 @@ +--- +title: 3. Integration Test Result (통합 테스트 결과) +sidebar_position: 3 +--- + +# 2. Integration Test Result (통합 테스트 결과) diff --git a/docs/docs/software-test-specification/Intrduction.md b/docs/docs/software-test-specification/Intrduction.md new file mode 100644 index 00000000..01461e42 --- /dev/null +++ b/docs/docs/software-test-specification/Intrduction.md @@ -0,0 +1,7 @@ +--- +title: 1. Introduction (개요) +sidebar_position: 1 +--- + +# 1 Introduction (개요) +## 1.1 Purpose (목표) diff --git a/docs/docs/software-test-specification/_category_.json b/docs/docs/software-test-specification/_category_.json new file mode 100644 index 00000000..5d46e7f6 --- /dev/null +++ b/docs/docs/software-test-specification/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Software Test Specification", + "position": 6 +} diff --git a/docs/docs/software-test-specification/unit-test-result.md b/docs/docs/software-test-specification/unit-test-result.md new file mode 100644 index 00000000..72b2bf39 --- /dev/null +++ b/docs/docs/software-test-specification/unit-test-result.md @@ -0,0 +1,4 @@ +--- +title: 2. Unit Test Result (단위 테스트 결과) +sidebar_position: 2 +--- \ No newline at end of file diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55b..00000000 --- a/docs/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a00..00000000 --- a/docs/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index ea472bba..00000000 --- a/docs/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index ffddfa8e..00000000 --- a/docs/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -module.exports = { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/docs/tutorial-basics/create-a-page.md b/docs/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac30..00000000 --- a/docs/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee06..00000000 --- a/docs/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/docs/tutorial-basics/markdown-features.mdx b/docs/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 0337f34d..00000000 --- a/docs/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( -

Hello, Docusaurus!

- ) - } - ``` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - - :::tip My tip - - Use this awesome feature option - - ::: - - :::danger Take care - - This action is dangerous - - ::: - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/docs/tutorial-extras/_category_.json b/docs/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc19..00000000 --- a/docs/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e41646..00000000 Binary files a/docs/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/img/localeDropdown.png b/docs/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc1..00000000 Binary files a/docs/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/manage-docs-versions.md b/docs/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f34..00000000 --- a/docs/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/docs/tutorial-extras/translate-your-site.md b/docs/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index caeaffb0..00000000 --- a/docs/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -module.exports = { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a same time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1490537e..80398c25 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -11,10 +11,10 @@ const config = { favicon: 'img/favicon.ico', // Set the production url of your site here - url: 'https://depromeet.github.io', + url: 'https://docs.street-drop.com', // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: '/street-drop-server/', + baseUrl: '/', // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. @@ -54,7 +54,7 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ // Replace with your project's social card - image: 'img/docusaurus-social-card.jpg', + image: 'img/social-card.jpg', navbar: { title: 'Street Drop', logo: { diff --git a/docs/static/img/docusaurus-social-card.jpg b/docs/static/img/docusaurus-social-card.jpg deleted file mode 100644 index ffcb4482..00000000 Binary files a/docs/static/img/docusaurus-social-card.jpg and /dev/null differ diff --git a/docs/static/img/docusaurus.png b/docs/static/img/docusaurus.png deleted file mode 100644 index f458149e..00000000 Binary files a/docs/static/img/docusaurus.png and /dev/null differ diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico index c01d54bc..2828bbc0 100644 Binary files a/docs/static/img/favicon.ico and b/docs/static/img/favicon.ico differ diff --git a/docs/static/img/social-card.jpg b/docs/static/img/social-card.jpg new file mode 100644 index 00000000..dd3d154f Binary files /dev/null and b/docs/static/img/social-card.jpg differ diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docs/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49..00000000 --- a/docs/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docs/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08..00000000 --- a/docs/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docs/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d33..00000000 --- a/docs/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -