Skip to content

Latest commit

 

History

History
150 lines (90 loc) · 3.29 KB

EDIT_TEMPLATE.md

File metadata and controls

150 lines (90 loc) · 3.29 KB

1. How do I edit this template?

To get started, follow these steps:

1.1. Rename the root folder

Before: reactjs-starter-template-antd

After: your-app-name.

1.2. Edit package.json:

Change line 2

Before: "name": "reactjs-starter-template-antd"

After: "name": "your-app-name".

1.3. Modify CONTRIBUTING.md:

  • Line 4: Replace the repository name with githib-repo-name

Before:

-   Does it make developing reactjs-starter-template-antd easier?

After:

-   Does it make developing githib-repo-name easier?
  • Line 5: Replace the issue link

Before:

-   Does it fix a bug? -> Create an [issue](https://github.com/lifeparticle/reactjs-starter-template-antd/issues/new) with the steps to reproduce

After:

-   Does it fix a bug? -> Create an [issue](https://github.com/github-user-name/githib-repo-name/issues/new) with the steps to reproduce
  • Line 7: Replace the repository name with your repository name and goal

Before:

-   Does it stick to the original goal of reactjs-starter-template-antd -> ReactJS starter template with Ant Design

After:

-   Does it stick to the original goal of githib-repo-name -> Goal
  • Line 71: Replace the existing repository link with your specific link.

Before:

git remote add upstream git@github.com:lifeparticle/reactjs-starter-template-antd.git

After:

git remote add upstream git@github.com:github-user-name/githib-repo-name.git
  • Line 126: Update the pull request link to your repository's link.

Before:

https://github.com/lifeparticle/reactjs-starter-template-antd/pulls

After:

https://github.com/github-user-name/githib-repo-name/pulls

1.4. Modify CODE_OF_CONDUCT.md:

  • Line 64: Replace [INSERT CONTACT METHOD].

1.5. Modify LICENSE:

This project is currently licensed under MIT, but you are welcome to use any other license of your choice. If you decide to stick with the MIT license, please update line 3 to reflect the current year and include either your name or the name of your organization.

Before:

Copyright (c) 2023 Mahbub Zaman

After:

Copyright (c) 9973 Alice

1.6. Update the Introduction section with your project description

Introduction

1.7. Update the styles folder with your CSS variables (Optional)

Get inspiration from open-props

1.8 Change font (Optional)

  • Update /src/hooks/useTheme.ts

1.9 Change the page not found page (Optional)

  • Update the /src/pages/PageNotFound/PageNotFound.tsx file

1.10. Modify SECURITY.md:

  • Line 5: Replace [INSERT CONTACT METHOD].

1.11 Update public/robots.txt according to your needs

1.12 Update index.html according to your needs

1.13 Configurations Specific to GitHub, remove these if you're using BitBucket, GitLab, or any other platforms:

Update issue and pull request templates according to your needs

  • /.github/ISSUE_TEMPLATE
  • /.github/pull_request_template.md

2. How was this project created? (Educational Purposes)

See the creation details here: HOW

3. Delete the HOW.md and EDIT_TEMPLATE.md file