|
1 | | -# Data and Software Belgium Blog - Summer 2025 |
| 1 | +# Best Life App Development Blog |
2 | 2 |
|
3 | | -This repository contains a template for your Team's Blog. It is a Hugo-based blog uses a customized Blowfish theme. Blowfish supports multiple authors. |
4 | | - |
5 | | -## Local Development Setup |
6 | | - |
7 | | -**Note:** Everyone needs a GitHub account! |
8 | | - |
9 | | -<!-- ### Prerequisites |
10 | | -
|
11 | | -- Git |
12 | | -- Hugo (Extended version) --> |
13 | | - |
14 | | -### Installing Hugo |
15 | | - |
16 | | -#### Installing Hugo on macOS |
17 | | - |
18 | | -Using Homebrew: |
19 | | - |
20 | | -```bash |
21 | | -brew install hugo |
22 | | -``` |
23 | | - |
24 | | -#### Installing Hugo on Windows |
25 | | - |
26 | | -1. Download the latest release from [Hugo Releases](https://github.com/gohugoio/hugo/releases) |
27 | | -2. Extract the downloaded zip file |
28 | | -3. Add the Hugo executable to your system PATH |
29 | | - |
30 | | -### Getting Started |
31 | | - |
32 | | -1. One team member needs to fork the repo. We'll refer to this team member as the _blog owner_. **Change the name to your team name if you have one. If not, no better time to come up with one.** |
33 | | -1. The blog owner should add remaining team members as collaborators in GitHub. you can do this from the repo's Settings Tab > Collaborators and Teams. Each team member will receive an invitation to join the repo via email which they will need to accept. |
34 | | -1. Clone the team's repository: |
35 | | - |
36 | | -```bash |
37 | | -git clone [repository-url] |
38 | | -cd |
39 | | -``` |
40 | | - |
41 | | -2. Start the development server: |
42 | | - |
43 | | -```bash |
44 | | -hugo server -D |
45 | | -``` |
46 | | - |
47 | | -The site will be available at `http://localhost:1313` |
48 | | - |
49 | | -## Adding New Authors |
50 | | - |
51 | | -1. For each Team Member, update the `data/authors` folder to include a new `.json` file based on the examples included. |
52 | | -2. For each Team Member, create a new folder in `content`. Inside each, add an `_index.md` file |
53 | | - |
54 | | -## Creating New Content |
55 | | - |
56 | | -### Basic Post Structure |
57 | | - |
58 | | -1. Create a new markdown file in your author directory or in `content/team_posts/` |
59 | | -2. Use the following frontmatter structure: |
60 | | - |
61 | | -```markdown |
62 | | ---- |
63 | | -title: "Your Post Title" |
64 | | -description: "Brief description of your post" |
65 | | -date: YYYY-MM-DD |
66 | | -draft: false |
67 | | -tags: ["tag1", "tag2"] |
68 | | -categories: ["category1"] |
69 | | -authors: |
70 | | - - "eric_gerber" |
71 | | - - "mark_fontenot" |
72 | | ---- |
73 | | -``` |
74 | | - |
75 | | -### Markdown Basics |
76 | | - |
77 | | -- Use `#` for headings (e.g., `# Heading 1`, `## Heading 2`) |
78 | | -- Use `*` or `_` for emphasis (`*italic*`, `**bold**`) |
79 | | -- Create lists with `-` or `1.` |
80 | | -- Create links with `[text](url)` |
81 | | -- Create code blocks with triple backticks (```) |
82 | | - |
83 | | -## Working with Images and Assets |
84 | | - |
85 | | -### Adding Images |
86 | | - |
87 | | -1. Place your images in the `assets` directory |
88 | | -2. Reference images in your markdown using the following syntax: |
89 | | - |
90 | | -```markdown |
91 | | - |
92 | | -``` |
93 | | - |
94 | | -### Best Practices for Images |
95 | | - |
96 | | -- Use descriptive filenames |
97 | | -- Optimize images for web use |
98 | | -- Recommended formats: JPG for photos, PNG for graphics with transparency |
99 | | -- Keep image sizes reasonable (recommended max width: 1200px) |
100 | | - |
101 | | -## Additional Resources |
102 | | - |
103 | | -- [Hugo Documentation](https://gohugo.io/documentation/) |
104 | | -- [Markdown Guide](https://www.markdownguide.org/) |
105 | | -- [Blowfish Theme Documentation](https://blowfish.page/) |
| 3 | +Best Life is a web app developed in Leuven, Belgium by four Northeastern University students on a Dialogue of Civilizations focused on data and software in international government and politics. It provides insight in Europeon Union member states on how a user can improve their own or others' quality of life based on a set of priorities. This blog provides an overview of our app development process and details each team member's contributions to this project. |
0 commit comments