-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8bbbd04
commit 9b7d079
Showing
14 changed files
with
1,161 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Developing | ||
|
||
For development, you can deploy through Docker. This will install everything you need to get started. | ||
|
||
### For Windows: | ||
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) | ||
- You will also need to install a WSL that Docker can use | ||
|
||
### For Linux and Mac: | ||
- [Installing Docker](https://docs.docker.com/engine/install/ubuntu/) | ||
|
||
Once that's done, you can just run the following in the root of this directory: | ||
|
||
``` | ||
docker-compose up | ||
``` | ||
|
||
Note: This command will reference the `docker-compose.yml` and start up a virtual environment. That will then host the site on a local server | ||
|
||
Now your dev environment is ready! The local dev site will be available here: | ||
|
||
``` | ||
http://localhost:3000 | ||
``` | ||
|
||
If you wish to docker exec into the container, run a command similar to the following: | ||
|
||
``` | ||
docker exec -it ampwebv2_web_1 sh | ||
``` | ||
|
||
# Deploying | ||
|
||
The Amp Lab maintains a CI/CD pipeline. With every PR, you will see the website build on Github. As of October 2023, there are no formal tests in place to confirm code quality. However, the CI/CD pipeline will give you a decent look at whether or not the website builds. **Please** check the site before merging a pull request |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,10 @@ | ||
FROM node:19-alpine | ||
FROM node:18-alpine | ||
WORKDIR /app | ||
|
||
COPY package*.json pnpm-lock.yaml* ./ | ||
RUN npm install | ||
COPY . . | ||
|
||
RUN npm run build | ||
ENV NODE_ENV production | ||
|
||
EXPOSE 3000 | ||
ENV PORT 3000 | ||
|
||
CMD ["npm", "start"] | ||
CMD ["npm", "run", "dev"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.