Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #172

Merged
merged 6 commits into from
Jun 28, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions data/projects/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
## Add new project to projects list

1. Add new file inside `[...]/data/projects.ts` folder
2. Add project details inside the file already created, to easily include all the required parameters make sure to use the `ProjectInterface`
#### 1. Create a New Project File:
- Navigate to the [...]/data/projects folder within your project directory.
- Inside this folder, create a new file named example.ts.

#### 2. Add Project Details:
- Open the newly created example.ts file.
- To ensure all necessary parameters are included, use the ProjectInterface template. Here's a basic structure to get you started:

```js
export const example: ProjectInterface = {
Expand All @@ -17,7 +22,22 @@ export const example: ProjectInterface = {
}
```

3. Include the exported constant of the project in `projects.ts`
- Fill in the id, image, name, and tags fields as per your project's details. The tags object includes arrays for keywords, themes, types, and builtWith.

#### 3. Register the New Project:
- Open the projects.ts file located in the same directory or wherever your project's list is maintained.
- Add your new project to the projects array to make it visible:

```js
import { example } from './projects/example';

const projects: ProjectInterface[] = [
// other projects
example,
];
```

By following these steps, you will successfully add a new project and ensure it is correctly registered and visible.

## Show badges in the project card

Expand Down