Skip to content

Commit

Permalink
Merge pull request #104 from seanmorley15/development
Browse files Browse the repository at this point in the history
Development
  • Loading branch information
seanmorley15 authored Jul 9, 2024
2 parents 032196d + d64abf2 commit 2bcb0b0
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 160 deletions.
11 changes: 6 additions & 5 deletions backend/server/adventures/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ def clean(self):
raise ValidationError('Adventures must be associated with trips owned by the same user. Trip owner: ' + self.trip.user_id.username + ' Adventure owner: ' + self.user_id.username)
if self.type != self.trip.type:
raise ValidationError('Adventure type must match trip type. Trip type: ' + self.trip.type + ' Adventure type: ' + self.type)
if self.type == 'featured' and not self.is_public:
raise ValidationError('Featured adventures must be public. Adventure: ' + self.name)

def __str__(self):
return self.name
Expand All @@ -60,13 +62,12 @@ class Trip(models.Model):

# if connected adventures are private and trip is public, raise an error
def clean(self):
if self.is_public:
if self.is_public and self.pk: # Only check if the instance has a primary key
for adventure in self.adventure_set.all():
if not adventure.is_public:
raise ValidationError('Public trips cannot be associated with private adventures. Trip: ' + self.name + ' Adventure: ' + adventure.name)

if self.type == 'featured' and not self.is_public:
raise ValidationError('Featured trips must be public. Trip: ' + self.name)

def __str__(self):
return self.name

return self.name
7 changes: 5 additions & 2 deletions backend/server/adventures/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class AdventureSerializer(serializers.ModelSerializer):

class Meta:
model = Adventure
fields = '__all__' # Serialize all fields of the Adventure model
fields = '__all__'

def to_representation(self, instance):
representation = super().to_representation(instance)
Expand All @@ -19,9 +19,12 @@ def to_representation(self, instance):
return representation

class TripSerializer(serializers.ModelSerializer):
adventures = AdventureSerializer(many=True, read_only=True, source='adventure_set')

class Meta:
model = Trip
fields = '__all__' # Serialize all fields of the Adventure model
# fields are all plus the adventures field
fields = ['id', 'user_id', 'name', 'type', 'location', 'date', 'is_public', 'adventures']



15 changes: 8 additions & 7 deletions backend/server/adventures/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from .models import Adventure, Trip
from .serializers import AdventureSerializer, TripSerializer
from rest_framework.permissions import IsAuthenticated
from django.db.models import Q
from django.db.models import Q, Prefetch
from .permissions import IsOwnerOrReadOnly

class AdventureViewSet(viewsets.ModelViewSet):
Expand Down Expand Up @@ -47,28 +47,29 @@ class TripViewSet(viewsets.ModelViewSet):
def get_queryset(self):
return Trip.objects.filter(
Q(is_public=True) | Q(user_id=self.request.user.id)
).prefetch_related(
Prefetch('adventure_set', queryset=Adventure.objects.filter(
Q(is_public=True) | Q(user_id=self.request.user.id)
))
)

def perform_create(self, serializer):
serializer.save(user_id=self.request.user)

@action(detail=False, methods=['get'])
def visited(self, request):
trips = Trip.objects.filter(
type='visited', user_id=request.user.id)
trips = self.get_queryset().filter(type='visited', user_id=request.user.id)
serializer = self.get_serializer(trips, many=True)
return Response(serializer.data)

@action(detail=False, methods=['get'])
def planned(self, request):
trips = Trip.objects.filter(
type='planned', user_id=request.user.id)
trips = self.get_queryset().filter(type='planned', user_id=request.user.id)
serializer = self.get_serializer(trips, many=True)
return Response(serializer.data)

@action(detail=False, methods=['get'])
def featured(self, request):
trips = Trip.objects.filter(
type='featured', is_public=True)
trips = self.get_queryset().filter(type='featured', is_public=True)
serializer = self.get_serializer(trips, many=True)
return Response(serializer.data)
2 changes: 0 additions & 2 deletions documentation/docs/Installation/congratulations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ You have just learned the **basics of Docusaurus** and made some changes to the

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?
Expand Down
55 changes: 0 additions & 55 deletions documentation/docs/Usage/manage-docs-versions.md
Original file line number Diff line number Diff line change
@@ -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"
export default {
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`
88 changes: 0 additions & 88 deletions documentation/docs/Usage/translate-your-site.md
Original file line number Diff line number Diff line change
@@ -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"
export default {
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 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"
export default {
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
```
2 changes: 1 addition & 1 deletion documentation/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const config: Config = {
favicon: "img/favicon.png",

// Set the production url of your site here
url: "https://your-docusaurus-site.example.com",
url: "https://docs.adventurelog.app/",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
Expand Down

0 comments on commit 2bcb0b0

Please sign in to comment.